Commit Graph
41 Commits
Author SHA1 Message Date
0bdee8757b Docs: Document Prometheus-Alertmanager integration settings (#57043)
* Docs: Document Prometheus AM integration settings

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

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

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-12-05 14:01:12 +01:00
b0c197b966 Docs: Comment out broken images (#57482)
* Docs: Comment out broken images

* Docs: Hide the correct images

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Daniel Lee <dan.limerick@gmail.com>
2022-11-14 10:49:04 +01:00
Garrett GuillotteandTorkel Ödegaard 852d069a3c Docs: Refactor data sources content (#57573)
* Docs: Revise data source index

* Docs: Consolidate data source administration docs

* Docs: Revise panels docs related to data sources

* Docs: Revise Alertmanager data source

* Docs: Reorganize AWS CloudWatch data source docs

* Docs: Reorganize Azure Monitor data source docs

* Docs: Move azuremonitor to azure-monitor

* Docs: Revise Elasticsearch docs

* Docs: Move Elasticsearch index into bundle

* Docs: Revise GCM docs

* Docs: Revise Graphite docs

* Docs: Move Graphite index into bundle

* Docs: Revise InfluxDB docs

* Docs: Revise Jaeger docs

* Docs: Move Jaeger index into bundle

* Docs: Revise Loki docs

* Docs: Move Loki index into bundle

* Docs: Revise MS SQL docs

* Docs: Move MS SQL index into bundle

* Docs: Revise Prometheus docs

* Docs: Move Prometheus index into bundle

* Docs: Revise Tempo docs

* Docs: Move Tempo index into bundle

* Docs: Revise TestData DB docs

* Docs: Move TestData DB index into bundle

* Docs: Revise Zipkin docs

* Docs: Move Zipkin index into bundle

* Docs: Move other data sources' index pages into bundles

* Docs: Revise frontmatter

* Fixing hugo markdown errors

* Docs: Add query editor and template var sections to overview doc

* Docs: Remove CTAs across data source docs

* Docs: Remove CTA

* Docs: Remove CTA

* Docs: Fix links, images, typos, and usage consistency.

* Docs: Fix typos

* Docs: Fix CI issues

* Update docs/sources/datasources/_index.md

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

* Update docs/sources/datasources/_index.md

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

* Docs: Fix query editor links

* Update docs/sources/panels-visualizations/_index.md

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

* Update docs/sources/panels-visualizations/_index.md

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

* Docs: Rebundle child pages per writers' toolkit

* Docs: Fix prettier for CI

* Docs: Fix relrefs from outside data sources docs

* Docs: Fix broken relrefs within datasources

* Docs: Fix relrefs to data sources docs

* Fixed some more refs

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-11-01 10:22:06 -05:00
Garrett Guillotte 0db946977b Docs: Reassign docs ownership (#57701) 2022-10-26 15:20:25 -07:00
Garrett Guillotte c70bb592fe Docs: Fix reference to Enterprise licensing restrictions (#57230) 2022-10-19 13:20:47 -05:00
Garrett Guillotte a0d83e7db7 Docs: Add missing alias for field options (#57234) 2022-10-19 14:13:17 -04:00
Garrett Guillotte e14ef50d02 Docs: Fix broken InfluxDB starting guide links (#57235)
* Docs: Fix broken InfluxDB starting guide links

* Docs: Fix another link to panel adding docs
2022-10-19 07:52:15 -07:00
Garrett Guillotte 9680249066 Docs: Fix links in old What's New docs (#57231)
* Docs: Fix placeholder URL in release notes link

* Docs: Fix link to refactored docs and add missing alias

* Docs: Fix malformed links

* Docs: Fix alias with correct path
2022-10-19 07:51:49 -07:00
Garrett Guillotte e52c98ba99 Docs: Fix links in panels and vis docs (#57233) 2022-10-19 07:41:34 -05:00
Garrett Guillotte 2bed451990 Docs: Contextualize base64 encoding in Basic Authorization (#57046) 2022-10-17 08:53:17 -07:00
Garrett Guillotte 4831091115 Docs: Fix provisioning table formatting (#57042) 2022-10-16 11:05:47 -05:00
Garrett Guillotte 0889c3ad07 Docs: Clarify and document dashboard URL query parameters for variables (#56055) 2022-10-15 18:07:25 -07:00
Garrett Guillotte 2b4d57fe60 Docs: Note end of release notes publication (#57013)
* Docs: Note cessation of release notes

* Docs: Update What's New index mention of release notes

* Docs: Update links and references to the release notes

* Docs: Fix relrefs

* Docs: Spellcheck
2022-10-14 18:24:32 +01:00
Garrett Guillotte f4a3400a9c Docs: Update Canvas videos to mp4 URLs (#56748) 2022-10-11 11:39:52 -07:00
Garrett Guillotte abd7b7dccc Docs: Remove Beta tag from 9.2 What's New post-release (#56746) 2022-10-11 13:16:24 -05:00
Garrett Guillotte 4a99470e22 Docs: Add CODEOWNER to setup docs (#56745) 2022-10-11 13:43:58 -04:00
Garrett Guillotte c98db1615f Docs: Clarify JOIN feature change (#56740) 2022-10-11 18:23:48 +02:00
Garrett GuillotteandRajakavitha Kodhandapani ef1aa8ceb8 Docs: Add link to TimescaleDB docs (#56134)
* Added a link for more information

Added a link to TimescaleDB so that users can get additional information if need be.

* fixed formatting

* fixed the table

* made it prettier

* make it pretty for CI

Co-authored-by: Rajakavitha Kodhandapani <krajakavitha@gmail.com>
2022-09-30 15:35:11 -07:00
Garrett Guillotte 1485209287 Docs: Add screenshots to What's New in v9.2 (#55862)
* Docs: Add What's New in Grafana v9.2 Beta

* Docs: Add links to What's New in Grafana v9.2

* Docs: Apply updates to What's New
2022-09-27 11:11:14 -07:00
Garrett Guillotte 3409979288 Docs: Add What's New in Grafana v9.2 Beta (#55855) 2022-09-27 12:09:00 -05:00
Garrett Guillotte 8863c4c140 Update CODEOWNERS with specific docs responsibilities (#55522)
* Update CODEOWNERS with specific docs responsibilities

* Docs: Per Ursula, hand off enterprise docs
2022-09-22 15:26:03 -04:00
Garrett GuillotteandFiona Artiaga f0e3b9b16b Docs: Clarify "supported data sources" (#54337)
* Docs: Clarify "supported data sources"

The term "supported" is context-dependent. Clarify the data sources
index page to link to the plugins catalog with additional detail,
and specify that the links to data sources are for those with
additional documentation content as part of Grafana.

Add a link to the tutorial to build a data source plugin.

* Update docs/sources/datasources/_index.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
2022-09-22 15:23:15 -04:00
Garrett Guillotte a98a33774b Docs: Fix relrefs in access control API docs (#51940)
* Fix relrefs in access control API docs

* Apply Prettier changes to fix CI
2022-09-22 15:13:23 -04:00
Garrett Guillotte 72ec1eba1a Docs: Note issue #13399 in database install docs (#55596)
* Docs: Note issue #13399 in database install docs

* Docs: Be more specific about serverless Aurora MySQL
2022-09-22 12:00:48 -07:00
Garrett Guillotte 29018d522c Docs: Fix link to config docs (#55396) 2022-09-21 11:42:39 -07:00
Garrett Guillotte 97ca109d84 Docs: Fix Cloud availability of JWT URL Embedding (#55260)
* Docs: Fix Cloud availability of JWT URL Embedding

* Docs: Clarify JWT URL embedding availability in docs
2022-09-15 10:57:38 -07:00
Garrett GuillotteandFabio Michelini 47364ae11f fix configuration secret_key relref link (#52742)
Co-authored-by: Fabio Michelini <fabio.michelini@protonmail.com>
2022-08-16 10:57:08 +02:00
Garrett Guillotte 25e546ad21 Docs: Fix link in What's New in 9.1 (#53259) 2022-08-16 10:54:33 +02:00
Garrett Guillotte 1f692d4020 Docs: Add 9.1 to What's New index (#53545)
* Docs: Add 9.1 to What's New index

* Docs: Update docs index What's New link
2022-08-16 10:45:05 +02:00
e1bb23a2d7 Docs: Add What's New in v9.1 (#53066)
* Docs: Add What's New in v9.1

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Docs: Pass CI

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v9-1.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Docs: Apply style and semantic linebreak suggestions to 9.1 what's new

* Docs: Pass CI

* Removed reference to AWS SM project that has been pulled from announcement

* Docs: Pass CI

* Docs: Pass CI

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Tim Levett <tim.levett@grafana.com>
2022-08-02 11:07:36 -07:00
Garrett Guillotte 25edee88a7 Fix relrefs in product docs (#51944) 2022-07-08 12:25:19 -07:00
Garrett Guillotte 92577d3770 Fix relrefs in api keys doc (#51943) 2022-07-08 12:22:19 -07:00
Garrett Guillotte a243dc8713 Fix relrefs in alerting (#51939) 2022-07-08 12:21:56 -07:00
Garrett Guillotte 1c6ee69c2d Fix relrefs in devloper docs (#51942) 2022-07-08 12:21:29 -07:00
Garrett GuillotteandFiona Artiaga ef26c39cbd Docs: Fix Admin docs relrefs (#51060)
* Fix relrefs in CLI docs

* Fix relrefs in licensing docs

* Fix relrefs in AWS licensing docs

* Fix RBAC relrefs

* Fix Enterprise relrefs

* Fix data source management relrefs

* Fix server/org user management relrefs

* Remove redundant force-user-logout doc

* Fix add/remove user from org relrefs

* Fix user management relrefs

* Fix user management relrefs

* Fix link text typos

* Fix and add stats and license relrefs

* Fix index page relrefs

* Fix developer docs plugin relref to admin plugins doc

* Update docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Fix provisioning relrefs

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
2022-06-17 15:03:26 -07:00
Garrett Guillotte 845cebdee2 Docs: Refactor administration docs (#50592)
* Move data source management to administration

* Move RBAC to administration

* Move team management up a docs org level

* Combine and rename admin preferences docs

* Move plugin management to administration

* Combine plugin management docs

* Combine API key docs

* Combine service account docs

* Combine server user management docs

* Move datasource management to administration

* Move enterprise licenses to administration

* Move CLI out of admin, update links to admin

* Merge org user management docs

* Restructure to Torkel's plan

* Fix typo

* Weigh admin topics for navigation

* Weigh administration topics and align to Torkel's plan

* Move server user management from server admin to admin/user management

* Move configure docker image to setup guide

* Move the remaining server admin docs to the root admin directory

* Reweight docker config
2022-06-16 21:09:16 +02:00
Garrett Guillotte 3ecee06630 Docs: Identify which Grafana editions are relevant to each Enterprise doc (#49207)
* Add section to Ent docs index re: Cloud features
* Add and update notes identifying Enterprise and Cloud features
* Address feedback
2022-05-25 12:31:49 -07:00
Garrett Guillotte d93bcd547e Docs: Clarify transformation functions reference docs (#46903)
* Docs: Remove 'Reference' prefix from all reference topic filenames: Per issue #46818, prefixing reference topics with "Reference" can damage usability. Remove the prefix from filenames.

* Docs: Remove "Reference:" prefix from titles and ToC headings: Per issue #46818, prefixing reference topics with "Reference" can damage usability. Remove the prefix from titles and ToC headings. H1s retain the prefix to emphasize the nature of the doc without affecting the docs' discoverability.

* Docs: Move Transformation functions reference alongside Transformation docs
* Docs: Update links to reference docs in Transformation docs
* Docs: Update links to reference docs in Panels docs
* Docs: Update links to query options reference across docs
* Docs: Update links to standard field definitions reference across docs
* Docs: Update links to calculation types reference across docs
* Docs: Update links to transformation functions reference across docs
* Docs: Rename apply transformation doc filename to add transformation
* Docs: Rename apply transformation doc to add transformation
* Docs: Update links to add transformation doc across docs
* Docs: Update relrefs in Transformation functions reference
2022-04-21 15:16:22 +02:00
42431e6ad4 Explore/Logs: Improve and add descriptions of Explore's Escape newlines feature (#46709)
* Explore/Logs: Clarify phrasing of newline escape fix tooltip

Rewrite the tooltip for the smart feature in PR #31352 that
replaces incorrectly escaped newlines in log lines.

-   Clarify the functionality of the feature to emphasize its
    interactivity.
-   Remove language suggesting that the feature is experimental,
    when we intended to suggest reviewing the results manually for
    correctness.

* Docs: Document escape newlines feature

Describe and provide steps for using the "Escape newlines" feature
in Explore added in PR #31352.

* Rewrite topic lead to clarify conditional behavior

* Describe reversion of replacements as a standalone task

Reverting the replacements is a separate action, so it should have
its own task. This also describes the option's transformation and
tightens the task language.

* Remove Grafana 7 version qualifier

* Clarify escape sequence detection lede on task

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Clarify "Remove escaping" state change

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Clarify confidence of tooltip content

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-04-12 09:22:28 +02:00
Garrett Guillotte b2f33b2a53 Docs: Revert move of "Config from query" options (#46865)
Refactoring in 449c608 / PR #43569 moved the "Options" subsection
of the "Config from query" transformation to be a subsection of
the "Apply transformation to data" doc, but those options are not
relevant to that content.

Move this content to be a subsection of the "Config from query"
transformation in the transformation functions reference doc.
2022-03-23 10:37:12 -04:00
Garrett Guillotte fb06804450 Docs: Fix labels to fields transformer subsections (#46422)
Refactoring in PR #43569 (commit 3b39c9f) resulted in subsections
of the Labels to Fields transformer's docs being unintentionally
moved under the Organize transformer section. Move these back
under Labels to Fields.
2022-03-16 13:47:12 -04:00