84 Commits

Author SHA1 Message Date
43f7309272 Docs: updates to recording rules (#72218) 2023-07-24 20:35:55 +02:00
43fb14ef8c Docs: updates alerting rules docs (#72190)
* Docs: updates alerting rules docs

* Docs: adds queries and conditions topic
2023-07-24 15:57:41 +02:00
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
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
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
5159317ee7 Docs: adds evaluation doc (#70757)
* Docs: adds evaluation doc

* Adds note on classic condition

* fixes link

* fixes link

* fixes link

* fixes data source

* link fix

* fixes rbac link

* adds aliases
2023-06-28 10:38:59 +02:00
f436364f9b Docs: adds queries and conditions doc (#70674)
* Docs: adds queries and conditions doc

* fixes link

* fixes link

* fix link

* fixes typo

* corrects relref

---------

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
2023-06-26 09:28:39 -05:00
d8ffc6be5e Docs: fixes minor errors (#70458)
* Docs: fixes minor errors

* adds links

* remove trailing slash

---------

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
2023-06-21 11:53:24 -05:00
cd8e5dc140 Docs: rearrange content order (#70425)
* Docs: rearrange content order

* more rearranging

* fixes relrefs

* fixes links
2023-06-21 11:30:52 +02:00
701c6b6f07 Docs: fixes various links (#70384)
* Docs: fixes various links

* bit more moving

* corrects link

* fixes links

* fixes links from move

* fix links

* fix links

* fixes links

* fixes links

* fix typo

* fixes typo

* fix notif policy link

* fix link
2023-06-20 21:49:57 +02:00
c0dfaa626c Docs: Adds fixes for external PRs (#69997)
* Adds fixes for external PRs

* fixes typo

* capitalizes alertmanager
2023-06-13 14:17:50 +02:00
b10daa12b3 Docs: Add separate fundamentals topic on notification policies (#69174)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-31 15:19:33 +03:00
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
1c4bb9ca00 [feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

* Update docs/sources/datasources/mysql/_index.md

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition
2023-05-22 15:45:28 -05:00
69402f859b Docs: Add callout for variables behavior with classic conditions (#67253)
* Add doc on classic condition behaviour with labels

* Update docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-03 10:43:11 +02:00
7ed93cea54 Alerting: Fix bottom links(useful links) at contact points fundamentals page (#67695)
Fix bottom links(useful links) at contact points fundamentals page
2023-05-03 07:24:09 +00:00
2521fa9448 Docs: Fixes alert rule type table (#67090)
* Fixes alert rule type table

* adds responsive table markdown

* adds responsive table

* updates image text

* Adds word breaks

* fix responsive table
2023-04-24 13:48:57 +02:00
c742503d2c Docs: Updates intro alerting topics (#66958)
* Updates intro alerting topics

* taking out cortex

* Adds choice table for alert rules type

* updates with Vikas feedback
2023-04-21 13:24:43 +02:00
58e3b3a90e Update index.md (#66698)
The useful links were down as they were using /docs/grafana/next/ instead of /docs/grafana/latest/ in the path
2023-04-18 08:11:54 +02:00
c77aa11545 Docs: updates type to integration (#65591)
* Docs: updates type to integration

* fixes link

* fixes links
2023-03-30 10:23:06 +02:00
0464aebc8e Docs: Use correct function in labels and annotations docs (#65032)
Use correct function in labels and annotations docs
2023-03-23 10:10:49 +01:00
e243db6e6b Docs: fixes intro title (#65174)
fixes intro title
2023-03-22 12:53:40 +01:00
89c65e22d3 Docs: fix numbering and rename topic (#65093)
* Docs: fix numbering and rename topic

* fixes typo

* removes full stops

* deletes :
2023-03-21 13:37:00 +01:00
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
14208c4c42 Docs: Updates default template link (#64485)
Updates default template link
2023-03-09 09:18:36 +01:00
6827f97b78 Docs: update the current documentation on notification policies (#64316)
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-03-08 17:18:17 +01:00
c9497dc533 Docs: Improved docs for templating labels and annotations (#63539) 2023-02-23 08:51:46 +00:00
46cbcc813b Alerting: Fix default_template.go link in docs (#62885)
Fix default_template.go link in docs
2023-02-03 17:27:13 +01:00
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
a273c232a1 Alerting: fix default template link (#62251) 2023-01-26 17:45:09 +00:00
d4256b352d Docs: Rename Message templates to Notification templates (#59477)
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
2023-01-18 17:26:34 +00:00
37a0afe136 Docs: Fix links to default_template.go in alert template reference file (#61340)
Docs: Fix links to `default_template.go` alert template reference file
2023-01-13 11:32:45 +00:00
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
5c9d1a4706 Delete broken links in notifications doc (#59785)
* Delete broken links in notifications doc

* changes descendents to children

* deletes broken alertmanager link
2022-12-05 12:53:14 +01:00
311e1e56f2 Docs: Reference Alertmanagers in Notifications docs and move Alertmanager docs (#59673) 2022-12-02 09:41:01 +00:00
4073d044c1 Docs: Consolidate Templating labels and annotations docs into a single page (#59685) 2022-12-02 09:40:48 +00:00
8ed2426e8e Docs: Improve documentation for notifications (#59504) 2022-12-01 09:57:45 +00:00
c8c1499cd0 Docs: Add docs for labels with dots (#59352) 2022-11-29 13:15:48 +00:00
e7316ff13f Docs: Improve Labels and annotations docs (#59325)
This commit makes a number of changes to the docs for Labels and
annotations.

 1. It changes the order in which Labels and annotations are mentioned
    from Annotations and labels to Labels and annotations as this is
    the order shown in the UI when creating and editing alert rules.
    It is also the order in the Prometheus documentation.

 2. It changes most of the documentation explaining what labels and
    annotations are and the differences between them. It also adds
    some paragraphs on Custom Labels.
2022-11-28 14:09:02 +00:00
d748979048 Alerting: Implement the Webex notifier (#58480)
* Alerting: Implement the Webex notifier

Closes https://github.com/grafana/grafana/issues/11750

Signed-off-by: gotjosh <josue.abreu@gmail.com>
2022-11-11 17:27:13 +00:00
bd6ac793a0 Docs: adds explore content for alerting (#58573) 2022-11-10 12:35:24 +00:00
ee7adc081b Remove Sensu from docs (#57812)
We do not support Sensu in Grafana Alerting, only Sensu Go.
2022-10-28 12:40:46 +01:00
1d53a6f57e Docs: Change GA to Alerting (#57811)
* Docs: Change GA to Alerting

* typos
2022-10-28 10:28:02 +01:00
5edd511461 Docs: fixes alerting links (#57805)
* Docs: fixes alerting links

* fixes grafana relrefs to alerting

* changing GA to Alerting
2022-10-28 10:01:43 +01:00
f9d2801249 Docs: alerting refactor (#57804)
* Docs: alerting refactor

* fixes broken relrefs
2022-10-28 09:58:39 +02:00
998093a280 Docs: more refactoring for alerting (#57741)
* docs: more refactoring alerting

* performance limitations

* typo

* fix relrefs
2022-10-27 13:21:02 +01:00
279ac50d59 Docs: refactors notifications in alerting (#57734)
* Refactors noticifacations section

* adds hover over error icon detail
2022-10-27 11:19:03 +01:00
596b4fecb0 Docs: Refactors notifications in alerting (#57653)
* Refactors notifications in alerting

* Fixes broken links

* adds headings

* fixes broken links

* Adds line space and intro sentences
2022-10-26 19:07:49 +01:00
b7feb34acf Fix broken relrefs (#57092)
* Fixes relrefs

* Fixes more relrefs
2022-10-17 08:54:00 -07:00
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