Commit Graph

473 Commits

Author SHA1 Message Date
brendamuir 3227d0b5fd
Docs: removes screenshots (#69634) 2023-06-06 13:01:54 +02:00
arun tvs 09eca5981b
Fix: Fixed a typo in reference.md (#69204)
* Update reference.md

Fixed typo:

`i` to `in`

* Ran prettier
2023-06-06 08:27:49 +02:00
Gabriel Goller d850070f09
Docs: Added disableResolveMessage parameter (#66596)
Added disableResolveMessage parameter
2023-06-02 14:28:39 +02:00
Jack Baldry f29b058927
Update cascading front matter to use sequence form (#67094)
* Update cascading front matter to use sequence form

The map form does not override the sequence form that is used in the website repository to specify the default labels.
For more information, refer to https://github.com/grafana/writers-toolkit/pull/234.

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

* Remove useless alias

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

* Update labels for pages noted in code review

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

* Move all product labeling to the project index file

All changes can be made in a single place.

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

* Move all individual page product labels to project index file

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

* Shorten YAML

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

* Add newlines to aid readability

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

* Document front matter ordering

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

* Rewrite labels for breaking-changes pages

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

* updated labels for whats new and breaking changes

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-31 16:52:03 +01:00
Gilles De Mey 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
Jev Forsberg 731efdf7f4
Docs: update Legacy alerting deprecation to pass doc-validator (#69192)
* baldm0mma/doc-val/ update paths

* baldm0mma/doc-val/ update path

* baldm0mma/doc-val/ update trailing comma

* baldm0mma/doc-val
2023-05-26 13:46:14 -06:00
brendamuir 6bd3d4bf61
Docs: changes to upgrade docs (#69127)
* Docs: changes to upgrade docs

* updates links

* fixes links

* fixes links

* fixes deprecation message
2023-05-26 17:49:11 +02:00
gotjosh bf4ab36bc0
docs: revamp the alerting set-up documentation (#69064)
* docs: revamp the alerting set-up documentation

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

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

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

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

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-26 08:55:23 +02:00
Gilles De Mey 721d51a497
Alerting: Adds support for timezones in mute timings (#68813) 2023-05-25 16:19:33 +02:00
George Robinson 65e2df7a2e
Docs: Add JSON format for webhook notifications to differences (#68786) 2023-05-25 10:08:36 +01:00
Yuri Tseretyan 3af95bebe1
Alerting: Migrate unknown NoData\Error settings to the default (#68403)
* use default execution if legacy is not known

* update docs

* Update docs/sources/alerting/migrating-alerts/migrating-legacy-alerts.md

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

* Update docs/sources/alerting/migrating-alerts/migrating-legacy-alerts.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-24 13:09:17 -04: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
Santiago 4629c79c7a
Docs: Fix minor mistakes and rephrase "Manage your alert notifications" entry (#68851)
* Docs: Fix minor mistakes and rephrase docs for alert notifications

* Update docs/sources/alerting/manage-notifications/_index.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-23 11:15:02 -03:00
Matt Dodson 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
Hamed Karbasi e446a60800
Docs: Update alert data model of webhook-notifier documentation (#67956)
* Add missed fields to webhook-notifier.md
2023-05-12 09:40:05 -04:00
Gilles De Mey 4310f574db
docs: add legacy alerting deprecation notice (#68292)
Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-12 11:27:04 +02:00
bojankezele 5145f4d3f1
Update index.md (#67979)
removing an extra ':'
2023-05-10 11:53:38 +02:00
brendamuir 8e51c4895d
Docs: Fix routes in provisioning (#67970)
* Fix routes in provisioning

* fixes spacing
2023-05-09 08:53:12 +02:00
brendamuir cb9d53708e
Docs: Adds alert state history doc (#67976)
* Adds alert state history doc

* Adds config image

* Adds config as text

* correct spacing
2023-05-08 13:57:49 +02:00
brendamuir 6464ce0239
Docs: Adds preview notification template docs (#67903)
Adds preview notification template
2023-05-08 09:21:20 +02: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 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
Sonia Aguilar 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
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 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
brendamuir 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
brendamuir 4d2570ad72
Docs: updates time ranges and alert rule doc (#66760) 2023-04-20 13:14:19 +02:00
Alex Moreno f64a89727e
Alerting: Allow provenance disable in alerting provisioning API (#63650)
* Allow provenance None in alert rule update and rule group replace

* Allow provenance None in contact point update

* Allow updating policies to none by sending x-disable-provenance header

* Allow mute timings to disable provenance with x-disable-provenance header

* Allow disabling provenance by using x-disable-provenance header

* Add provenance helper to lower the cyclomatic complexity

* Do not downgrade provenance except un ReplaceRuleGroup

* Add function explanation and change error handling

* Add docs for x-disable-provenance changes (#66300)

* Add docs for x-disable-provenance changes

* Apply suggestions from code review

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

* Update _index.md

---------

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

* Add error message check in tests

* Change docs

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-04-18 15:10:36 +02:00
brendamuir 9fad5d938d
Docs: removes alerting video blurb version (#66748) 2023-04-18 13:09:08 +02:00
Sébastien Dauphin 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
Santiago a113d94bbb
Docs: Un-draft 'Configure Integrations' docs (#66699)
* Docs: Un-draft 'Configure Integrations' docs

* fix typo
2023-04-18 08:01:52 +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
Simon Crute a39190b613
Docs: Add the index function 2023-04-05 15:49:57 +03: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
brendamuir c77aa11545
Docs: updates type to integration (#65591)
* Docs: updates type to integration

* fixes link

* fixes links
2023-03-30 10:23:06 +02:00
Santiago 7b92849508
Alerting: Add CustomDetails field in PagerDuty contact point (#64860)
* Alerting: Add CustomDetails for PagerDuty

* fix default value for 'severity' from 'error' to 'critical'

* minimal docs for notifiers, specifying config for PagerDuty

* replace notifier -> integration

* replace notifier -> integration
2023-03-29 10:35:01 -03: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
annelaurefroment 7b7e417629
Updating documentation on alerting HA (#65064) 2023-03-23 11:34:38 +00:00
Martin Beentjes 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
brendamuir e243db6e6b
Docs: fixes intro title (#65174)
fixes intro title
2023-03-22 12:53:40 +01:00
brendamuir 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
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
Jack Baldry 72e50431df
Update page labels to better reflect contents (#64606)
* Set correct products labels on Grafana Cloud and Enterprise pages

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

* Add cloud label to all alerting docs

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-03-10 17:23:03 +00:00
George Robinson 1898e76dd6
Docs: Last iteration on docs for images in notifications (#64392)
This commit includes some minor rephrasing to the Requirements and
Limitations of the Images in notification feature.
2023-03-09 09:59:25 +00:00
brendamuir 14208c4c42
Docs: Updates default template link (#64485)
Updates default template link
2023-03-09 09:18:36 +01:00
Gilles De Mey 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
George Robinson 9d9421154e
Docs: Update Images in notifications docs to be more readable and instructive (#64227) 2023-03-07 10:52:33 +00:00
Matt Dodson 0099b23291
Docs, update for american English spelling (#63331)
Docs, update for american english
2023-03-06 06:39:56 -06:00