Commit Graph

55 Commits

Author SHA1 Message Date
brendamuir
d01d99a585
Alerting docs: change icon and simplified routing (#84729) 2024-03-19 21:29:45 +01:00
Pepe Cano
200ff7f9b4
Alerting docs: fix broken link (#84572) 2024-03-15 16:23:52 +01:00
Pepe Cano
ec42b2a361
Alerting docs: restructure Introduction (#84248)
* Rename `Data sources` title

* Relocate and rename `Introduction/Notification templates`

* Rename `alert-rules/alert-instances` to `alert-rules/multi-dimensional-alerts`

* Move `fundamentals/high-availability` to `setup/enable-ha`

* Fix 404 high-availability alerting link on Setup HA Grafana docs

* Move alert manager/contact poitns/notification templates within Notifications

* Remove `Alerting on numeric data`

* Restructure Introduction v2

* Continue Intro restructuring

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Complete contact point TODO

* Alias: alertManager

* Aliases `annotation-label` + content changes

* Aliases to `templating-labels-annotations`

* Aliases to `queries-conditions`

* Rename `rule-evaluation.md` file

* Aliases: `contact points`

* Aliases to `message-templating`

* Aliases to `alert-rules`

* Update links to new URL slugs

* Remove duplicated alias

* Remove trailing slash for external heading links

* Remove trailing slash in heading links to other grafana pages

* Change URL directory slug `fundamentals/notifications`

* rename title `Configure High Availability`

* Content changes

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Fix broken link reference

* Fix `queries-and-conditions`

* Fix `alert-rule-evaluation` ref link

* Fix aliases + inline doc comments

* Fix broken link

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-14 16:58:18 +01:00
brendamuir
05865034d7
Docs: removes note as recovery threshold now in cloud (#83907) 2024-03-05 14:22:03 +01:00
brendamuir
3901077f39
Alerting docs: changes weights and titles (#83519)
* Alerting docs: changes weights and titles

* language improvements to intro topic

* corrects rulle spelling

* adds alert instance info

* updates admonition note
2024-02-28 10:10:19 +02:00
brendamuir
93f18404c0
Alerting docs: readjust titles (#83504)
* Alerting docs: readjust titles

* removes outdated videos

* removes menutitle
2024-02-27 15:00:09 +02:00
brendamuir
d091e4c264
Alerting docs: adds simplified alert routing (#82158)
* Alerting docs: adds simplified alert routing

* adds to preview section

* adds numbering

* adds indent

* deletes fullstop

* ran prettier

* adds feature toggle notes

* fixes spelling error
2024-02-21 12:21:44 +01:00
Pepe Cano
b6098f2dde
Alerting docs: clean up Cloud links (#83073)
* Use fixed `/docs/grafana-cloud/alerting-and-irm` URLs for cloud references

* Fix `docs/grafana-cloud/` data sources links

* Fix `docs/grafana-cloud/` Panel & Visualization links

* Fix `/docs/grafana-cloud/` link to Dashboard page

* Set root directory `docs/reference` for non-cloud pages

* Fix `admonition` cannot use a  `docs/reference` relative link

* Update `doc-validator`

https://github.com/grafana/technical-documentation/releases/tag/doc-validator%2Fv4.1.0

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-20 11:49:39 +01:00
Jack Baldry
72c8ae2d8a
Remove duplicate paragraph and wrap in note (#82575) 2024-02-19 11:21:51 +00:00
Pepe Cano
3909b4c14a
Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00:00
brendamuir
85429f7bd0
Alerting docs: swap alert steps (#81249)
* Alerting docs: swap annotation and notification steps

* Updates data source managed rule steps
2024-01-25 12:02:35 +01:00
brendamuir
030a68bbf7
Alerting docs: recovery threshold (#81069)
* Alerting docs: recovery threshold

* ran prettier

* Adds note that only available in oss

* ran prettier
2024-01-25 10:28:32 +01:00
brendamuir
f20e98fac4
Docs: Alerting descriptions for alerting-rules section (#79376)
Alerting descriptions for alerting-rules section
2023-12-12 11:05:20 +01:00
Gilles De Mey
58d0c51cf4
Alerting: Add note to the docs that GMA rules are evaluated concurrently (#78902) 2023-12-01 18:32:48 +01:00
brendamuir
808e76ca05
Docs: adds note on gma alert limits (#78737)
* Docs: adds not on gma alert limits

* prettier
2023-11-29 08:46:38 +01:00
brendamuir
5fc68312c5
Docs: adds info on location for mute timings (#78462)
* Docs: adds info on location for mute timings

* ran prettier

* Update docs/sources/alerting/manage-notifications/mute-timings.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update docs/sources/alerting/manage-notifications/mute-timings.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Adds note on not being able to retrieve alerting resources once deleted

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-11-27 14:30:41 +01:00
Sonia Aguilar
0abfc3b6be
Alerting: Update 'Create alert' to 'New alert rule' in the panel and docs (#76950)
* Update 'Create alert' to 'New alert rule' in the panel and docs

* Fix test
2023-11-02 17:33:53 +01:00
Sonia Aguilar
a26318714f
Alerting: Update docs with the new create alert menu option in panels (#76825)
* Update docs with the new create alert menu option in panels

* fix errors

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-10-23 10:21:34 +02:00
brendamuir
f229758af0
Alerting docs: fixes numeric data link take 2 (#75166) 2023-09-20 19:02:34 +02:00
brendamuir
55a4d9b38e
Alerting docs: fixes numeric data link (#75155) 2023-09-20 14:09:17 +02:00
brendamuir
bccb5869a5
Alerting docs: link fixes and a note for expressions (#74317)
* Alerting docs: link fixes and a note for expressions

* changes format of note

* fixes extra space

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* update prometheus link

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-04 13:45:17 +02:00
brendamuir
bf5fa18137
Docs: updates to alert rule docs (#72313)
* Docs: updates to alert rule docs

* removes steps

* edits to numbering

* description parameter edit

* fixing description frontmatter
2023-07-26 09:18:13 +02:00
brendamuir
c6ab1ddb70
Docs: adds new alert rule creation flow (#72257)
* Docs: adds new alert rule creation flow

* updates configure alerting topic

* Adds grafana-managed process

* adds data source-managed and recording rule

* takes out anchor
2023-07-25 22:01:22 +02:00
Jack Baldry
37ef4e940f
Add canonical URLs to all alerting pages (#71830)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-18 11:29:00 +01:00
Jack Baldry
7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix introduction pages products

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
Jack Baldry
01f6b8e90c
Use docs/reference style links for all Alerting links (#71124)
* Replace all alerting links with docs/reference style links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix broken docs/reference style link

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update all alerting links to go to Grafana Cloud resources when the page is published in Grafana Cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Replace another link

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-10 11:51:29 +01:00
Jack Baldry
6c4cf4f8b9
Enable doc-validator for alerting directories (#68964)
* Enable doc-validator for alerting directories

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Adds missing description frontmatter

* Fix some more links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix some more links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixes anchors

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-24 14:12:30 +01:00
brendamuir
3684ca7c02
Docs: adds not on stale alerts (#67887)
* adds stale alert note

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>

* alex feedback

---------

Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
2023-05-08 09:20:57 +02:00
Alfredo
1013a3e253
Docs: Fix broken link for no data and error handling (#67617)
Fix broken link for no data and error handling
2023-05-02 14:14:20 +02:00
brendamuir
4d2570ad72
Docs: updates time ranges and alert rule doc (#66760) 2023-04-20 13:14:19 +02:00
brendamuir
9fad5d938d
Docs: removes alerting video blurb version (#66748) 2023-04-18 13:09:08 +02:00
Isabel
1b46d2f5bd
docs: nav update notes for videos (#66506)
* nav related notes for videos

* wording edit

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* wording edits

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-04-13 14:34:56 -04:00
brendamuir
a164b794ce
Docs: updates to error handling (#65599)
* Docs: updates to error handling

* ran prettier
2023-04-11 09:08:55 +02:00
Matthew Jacobson
b9dc04139a
Alerting: Respect "For" Duration for NoData alerts (#65574)
* Alerting: Respect "For" Duration for NoData alerts

This change modifies `resultNoData` to be more inline with the logic of the other state handlers.

The main effects of this are:

1) NoData states with NoDataState config set to Alerting will respect "For" duration.
2) Prevents zero value in StartsAt and EndsAt for alerts that have only even been in normal state. This includes state transitions from NoDataState=OK and ExecErrState=OK.
3) Better state transition logging.
2023-03-31 19:05:15 +03:00
Ashley Harrison
e39c3b76dd
Navigation: Rename Alerts & incidents to Alerts & IRM (#65635)
update Alerts & incidents to Alerts & IRM
2023-03-31 09:40:06 +01:00
Isabel
a5c5db3e91
docs: nav updates for alerting (#65300)
* navigation related updates - text only

* navigation related updates

* navigation related text updates

* navigation related text updates

* navigation related text and image updates
2023-03-23 13:26:16 -07:00
Jack Baldry
ebb54aea8d
Fix website build errors both for Grafana and content mounted in Grafana Cloud (#64794)
* Fix reference to Grafana CLI

- Make relref for relative permalink
- Use relative path for unambiguous resolution

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix alerting relref anchor format

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Avoid ambiguous relref lookups by forcing relative resolution

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove reference to non-existent shared page

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix links broken in Grafana Cloud using absolute relrefs

By resolving the relref absolutely, it refers to the same location
regardless of mounted directory.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove trailing slash for bundle independent resolution

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* For now, avoid Hugo checking cross repository /docs/grafana-cloud link

The path is unlikely to change in the short term and this makes CI
completely green for now.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* No need to specify path for in page anchors

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix prose

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-03-15 17:06:31 +00:00
brendamuir
d19803a0f0
Alerting docs: updates to alert rules docs for 9.4 (#62744)
* Alerting docs: updates to alert rules docs for 9.4

* Adds updates to oncall contact point and pause alerts

* Adds view read-only query update 9.4
2023-02-02 16:31:03 +00:00
Gilles De Mey
702fd0f9e8
Docs: Update wording / text and copy (#61868)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-01-30 15:26:21 +00:00
Jack Baldry
c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove aliases from shared pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Rewrite all current latest aliases to be next

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo in latest alias

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00
Sonia Aguilar
082c8ba7a0
Docs: Add step for custom labels in alert form (#59027) 2022-11-22 11:35:54 +01:00
Sonia Aguilar
97bf3c1dca
Alerting: Move alert rule name to the top left in alert form (#58579)
* Move alert rule name to the top left in alert form, and add a placeholder

* Update docs

* Fix lint error
2022-11-21 09:11:02 +01:00
Alex Pakalniskis
0e4108f62f
Documentation Update: Minor spelling change (#58933)
chore: minor grammar tweak
2022-11-18 11:34:25 +01:00
brendamuir
1d53a6f57e
Docs: Change GA to Alerting (#57811)
* Docs: Change GA to Alerting

* typos
2022-10-28 10:28:02 +01:00
brendamuir
998093a280
Docs: more refactoring for alerting (#57741)
* docs: more refactoring alerting

* performance limitations

* typo

* fix relrefs
2022-10-27 13:21:02 +01:00
Christopher Moyer
414d536186
Docs: refactors config panels and visualizations, corrects relrefs (#55940)
* refactors config panels and visualizations, corrects relrefs

* adds an alias

* Remove some old content

* moves visualizations topic to the root

* moves out panels and visualization topics to the root

* adds move and resize panel to add/organize panel; creates a create dashboard topic under build dashboards; adjusts context of add a panel to be from within an existing dashboard

* updates aliases

* creates search at root, moves dashboard preview to search, creates standalone search dashboard topic

* moves Set dashboard time range to use-dashboards, creates modify dashboard settings and adds moves Modify dashboard time settings to that topic

* moves existing query-options topic from working with panels to configure-panel-visualizations, moves panel time overrides and timeshift content to query options

* Moving things to better category, fixing links, improving ordering

* Move panel inspector to main panel topic

* completes partial fix of relrefs

* relref fixes con't

* restructures remaining panels topics

* more relref fixes

* Minor fix

* Minor tweak

* finishes fixing relrefs

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-11 15:31:20 -05:00
Garrett Guillotte
a243dc8713
Fix relrefs in alerting (#51939) 2022-07-08 12:21:56 -07:00
brendamuir
7deb7258ba
Docs: adds video content to Grafana Alerting (#50929)
* Docs: adds video content to grafana alerting

* adds create alerts to managed rule page
2022-06-16 16:11:38 +02:00
brendamuir
e0e76f0252
Fixes term Grafana Alerting (#50404) 2022-06-08 13:35:37 +02:00
Christopher Moyer
a568d421f8
Docs: Setup refactor (#49739)
* builds out refactored setup topics

* Automatically fix some relrefs with mv-manager

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use refs for tutorials content which is outside of this repository

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Manually fix complicated relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* consolidates team sync and db encryption topics

* Fix relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* updates setup index file

* Convert TOML to YAML

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add current alias for new alerting content

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add current aliases to new setup-grafana and configure-security pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

* moves saml docs, updates order in TOC

* Manually fix relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* added usage insights topics, adjusted weights

* corrected relrefs

* Fix relrefs broken in rebase

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-06-02 11:57:22 -05:00