Commit Graph

157 Commits

Author SHA1 Message Date
Grot (@grafanabot)
26c7cabef5 [v10.0.x] docs: crop panel filtering and time range screenshots (#70019)
docs: crop panel filtering and time range screenshots (#70017)

docs/crop panel filtering and time range screenshots

(cherry picked from commit 693e4ceb69)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-06-13 13:40:37 -04:00
Grot (@grafanabot)
a1576b83d2 [v10.0.x] docs: add product labels for reporting page (#69728)
docs: add product labels for reporting page (#69717)

add product labels for reporting page

(cherry picked from commit 994defeeb4)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-06-07 12:05:11 -04:00
Grot (@grafanabot)
f0fd0f50bb [v10.0.x] docs: update use dashboards descriptions (#69494)
docs: update use dashboards descriptions (#67360)

* Update index.md

* fix wording

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit eeb08a4662)

Co-authored-by: MattiasSegerdahl <102952046+MattiasSegerdahl@users.noreply.github.com>
2023-06-06 16:25:15 -04:00
Grot (@grafanabot)
6148dfc3d9 [v10.0.x] docs: add datasource selector content (#69587)
docs: add datasource selector content (#69280)

* updated create dashboard topic including adding screenshot of DS selector

* finished editing build dashboards - create dashboards

* finished data source selection edits'
:

* updated tutorials

* reverted tutorial to old nav to match reality and added that prom DS is preselected

* wording edits

* Apply suggestions from code review

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

* add that configure DS is only for admins

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
(cherry picked from commit 865636993f)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-06-05 15:14:34 -04:00
Grot (@grafanabot)
4fc9648845 [v10.0.x] docs: update add-template-variables docs (#69502)
docs: update add-template-variables docs (#65682)

correcting typo in "Filter and modify using named text and value capture groups" section

(cherry picked from commit 921bc0324e)

Co-authored-by: annelaurefroment <49911675+annelaurefroment@users.noreply.github.com>
2023-06-02 18:00:07 -04:00
Grot (@grafanabot)
9f9e4453bc [v10.0.x] docs: fix grafana play link (#69498)
docs: fix grafana play link (#65763)

* Update index.md

Fixed the link for a grafana play reference

* fix link text

* fix wording for flow

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 5dc07dedaa)

Co-authored-by: ashley <97468854+ansomerv@users.noreply.github.com>
2023-06-02 17:52:48 -04:00
Grot (@grafanabot)
d335b326e8 [v10.0.x] Update cascading front matter to use sequence form (#69328)
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>
(cherry picked from commit f29b058927)

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-06-01 08:29:56 +01:00
Grot (@grafanabot)
41ec10f49f [v10.0.x] docs: add pricing info for email sharing (#69221)
docs: add pricing info for email sharing (#69206)

added pricing info

(cherry picked from commit 4d0c1a4b8e)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-29 10:10:27 -04:00
Grot (@grafanabot)
e1f00558cd [v10.0.x] docs: Update "Create reports" doc to clarify custom time ranges and add information about drafts (#69093)
docs: Update "Create reports" doc to clarify custom time ranges and add information about drafts (#69015)

* Update index.md

Clarify that changes to dashboard time range are only reflected in the report if they are not using a custom time range.

Add information regarding saving a report as a draft.

* Update docs/sources/dashboards/create-reports/index.md

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

* running prettier

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
(cherry picked from commit 9a5262d5c8)

Co-authored-by: chrisharbro <102977229+chrisharbro@users.noreply.github.com>
2023-05-25 19:00:35 -04:00
Grot (@grafanabot)
0e37044bc3 [v10.0.x] docs: updates annotations Filter by panel and Add time region (#69119) 2023-05-25 17:14:16 -05:00
Jack Baldry
f5220c12ba [v10.0.x] [feat] docs; update admonition syntax (#69005)
* [v10.0.x] [feat] docs; update admonition syntax

* [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

(cherry picked from commit 1c4bb9ca00)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix incorrect conflict resolution

---------

Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
2023-05-24 22:14:24 +01:00
Grot (@grafanabot)
261ba03efe [v10.0.x] Edit global time variable - custom date formats use browser time (#69021)
Edit global time variable - custom date formats use browser time (#69016)

* Edit global time variable - custom date formats use browser time

Fixes https://github.com/grafana/grafana/issues/68748

* run prettier

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
(cherry picked from commit 7c2358862e)

Co-authored-by: Melori Arellano <melori.arellano@grafana.com>
2023-05-24 13:35:11 -07:00
Jack Baldry
2f866cda62 Revert "[v10.0.x] [feat] docs; update admonition syntax" (#68980)
Revert "[v10.0.x] [feat] docs; update admonition syntax (#68857)"

This reverts commit 1e8c28eff4.
2023-05-24 14:54:52 +01:00
Grot (@grafanabot)
1e8c28eff4 [v10.0.x] [feat] docs; update admonition syntax (#68857)
[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

(cherry picked from commit 1c4bb9ca00)

Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
2023-05-23 07:47:49 -05:00
Grot (@grafanabot)
05e0745d6b [v10.0.x] Docs: Update with annotations filtering and time regions (#68843) 2023-05-22 18:27:12 +02:00
Grot (@grafanabot)
6b356a52b9 [v10.0.x] Use expected types for admonition (#68175)
Use expected types for admonition (#68080)

All types are declared lowercased.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 356eabc24c)

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-05-10 09:49:58 +01:00
Grot (@grafanabot)
81c5fbba05 [v10.0.x] docs: add empty dashboard & Add dropdown screenshots (#68036)
docs: add empty dashboard & Add dropdown screenshots (#67588)

* added empty dashboard screenshots

* added Add dropdown screenshots

* removed screenshot from build first dashboard

* added Add dropdown guidance in panel editor page; updated headings

* added intro text in panel editor

(cherry picked from commit da21473527)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-08 15:04:30 -04:00
Grot (@grafanabot)
4fde55d85d [v10.0.x] docs: fix create dashboard steps (#67771)
docs: fix create dashboard steps (#67310)

* updated steps for dashboard creation

* added images, other wording and structure edits

(cherry picked from commit 4eb063c1dd)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-03 14:47:42 -04:00
Grot (@grafanabot)
98952d72c9 [v10.0.x] docs: add semi relative time ranges (#67755)
docs: add semi relative time ranges (#67559)

* add semi-relative time range section

* added second example and reworded

* formatting fixes

* added alerting note and fixed formatting

* wording fix

(cherry picked from commit 0271a1d094)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-03 11:56:25 -04:00
Grot (@grafanabot)
8e35a156be [v10.0.x] docs: add nav and users info for public dashboards (#67681)
docs: add nav and users info for public dashboards (#67674)

* add content re admin and public dashboards navigation

* added admin users section

(cherry picked from commit 765735092a)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-05-02 14:04:01 -04:00
Isabel
cc46581522 docs: add link to dashboard insights page (#67594)
* added link to dashboard insights docs

* shortened link text
2023-05-01 14:57:16 -04:00
Isabel
262cdcc789 docs: nav updates for assess dashboards topic (#67593)
* updated screenshots and nav info in data sources section

* removed redundant availability notes

* apply review suggestion
2023-05-01 14:56:58 -04:00
Isabel
60c4e71962 docs: public dashboards updates (#67173)
* add missing insights content, fix links, update intro content, fix incorrect workflow

* copy edits, image and link fixes

* Apply suggestions from code review

add/fix availability notes

* fix wording for clarity

* updated feature toggle page
2023-04-27 14:39:23 -04:00
MattiasSegerdahl
55c36b04ca docs: update dashboard settings page (#67359)
Update index.md
2023-04-27 13:38:55 -04:00
Eric Wang
278a8fccc9 Docs: Fix broken links to section on Variable syntax page (#67340)
These links have a trailing slash which don't work when linking to a
specific element.
2023-04-27 12:02:06 -04:00
samu6851
d208324331 Put the numbers before dashboard elements. (#65749)
* Put the numbers before dashboard elements.

Putting the numbers before the dashboard elements will make finding these easier for our customers as the first thing most people will do is look for the number that corresponds with the number in the photo.

* fixed icon name

---------

Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-04-13 15:45:02 -04:00
Isabel
4025927f7d docs: nav updates for enterprise and reports (#66389)
nav-related text updates
2023-04-12 11:28:30 -04:00
Isabel
8600a8ce2e docs: nav updates for use dashboard topic (#66151)
* updated main image and supporting text

* fixed icon name

* updated nav path
2023-04-06 16:43:38 -04:00
Isabel
3725463c43 docs: nav updates for dashboards (#66078)
* navigation related text and image updates in dashboards topics

* fix typo

* fixed style and formatting issues
2023-04-06 17:45:55 +01:00
sarah-spang
3685dd56e1 Docs: Small fixes for Template Variables Doc (#65947)
* Docs: Small fixes for Template Variables Doc

* Docs: Minor fix to Variables Docs

- Added missing word

* Update docs/sources/dashboards/variables/add-template-variables/index.md

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

* empty commit to trigger linting

* small change to trigger linting

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
2023-04-06 11:22:57 -05:00
Isabel
ab53772416 docs: updates for empty dashboard state (#65573)
* empty dashboard related updates

* updated steps to clearly indicate button names

Some steps indicated the heading as the thing to click rather than the button text. Also some of the button text wasn't quite accurate.

* remove incorrect instruction

* apply suggestion from review

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

* pushing empty commit to trigger linting

* triggering linting

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-04-03 10:33:55 -05:00
Isabel
1d38d03d09 docs: panel header updates (#65073)
* updated all text related to panel actions menu

* removed to do notes and updated intro text for panel inspect

* added screenshot

* added indents

* replaced panel links image and updated intro text

* added missed panel header related updates

* updated panel editor overview image

* chunked out steps per review feedback
2023-03-28 15:04:17 -05:00
Jack Baldry
dca5adeb98 Increase coverage of 'Grafana Cloud' labels (#64646)
* Add 'Grafana Cloud' label to content

All pages are applicable to both 'Open source' and 'Grafana Cloud'

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

* Add 'Grafana Cloud' label to administration content with some exceptions

- Enterprise licensing is 'Open source' and 'Enterprise'.
- 'Manage Organizations', 'Provision Grafana', and 'Stats and License' are 'Open source' only.

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

* Remove OSS from enterprise-licensing content

* Apply suggestions from code review

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-03-14 15:49:22 +00:00
owensmallwood
7b0b9a9d43 Pubdash: Adds docs for pubdash email sharing feature (#64563)
Adds docs for pubdash email sharing
2023-03-10 10:45:20 -06:00
Tania
6f67529a0a Docs: Add a note on uploading report branding logos (#64532)
* Docs: Add a note on uploading report branding logos

* Fix wording
2023-03-09 16:47:50 +01:00
Isabel
e7cd629e79 Revert "add manual prebuilt dashboards CTA banner" (#64264)
Revert "add manual prebuilt dashboards CTA banner (#64072)"

This reverts commit 976db3f53f.
2023-03-06 12:16:42 -08:00
Isabel
976db3f53f add manual prebuilt dashboards CTA banner (#64072)
Adds manual CTA banner to this page so it can be indexed for SEO purposes. Current banner is being managed by our CTA tracking tool, which is not being indexed.
2023-03-02 13:04:59 -08:00
Isabel
56dcf1619f docs: fix formatting public dashboards (#64069)
* fix formatting public dashboards 

Fix formatting of headings and change bullet lists to numbered lists where the items are steps

* fix "click on" wording

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

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-03-02 12:29:49 -08:00
juanicabanas
4e74768530 PublicDashboards: Email sharing (#63762)
Feature for sharing a public dashboard by email
2023-02-28 09:02:23 -03:00
Isabel
09943407e4 docs: fix broken annotations link (#62834)
* docs: fix broken annotations link

Link to annotations section is broken because the section was never added. A placeholder for it was removed on this commit, but the link wasn't. This seems like the best place to point to.

* fix relref formatting

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

* removed TODOs from tables

* prettier linting

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-02-06 10:48:42 -06:00
Christopher Moyer
060e0a4d18 Docs: corrects incorrect redirect and fixes link (#62815)
corrects incorrect redirect and fixes link
2023-02-02 13:42:21 -06:00
Isabel
1225e8d6d8 docs: fix broken elasticsearch metrics play link (#62715)
fix broken elastic search play link
2023-02-01 11:55:22 -06:00
Isabel
290f23a50b docs: clarify note re export dashboard as PDF (#62398)
clarify note re export dashboard as PDF

Update note under Export dashboard as PDF to indicate that it's only available on Enterprise and Cloud, as well as which version of Enterprise it's available on.
2023-01-27 13:31:55 -06:00
Isabel
9223fe5ca8 update adding new panel wording (#61817)
updated adding new panel wording
2023-01-19 13:45:07 -08:00
bobemoe
59df361087 Public Dashboards: Docs: add ENV method to enable (#60412)
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-01-16 09:26:05 -03:00
Christopher Moyer
b5834fd6d3 docs: fixes links (#60541)
fixes links
2022-12-20 08:18:56 -06:00
Jack Baldry
97f01c0d1a Apply linting advice from doc-validator tool (#59606)
* Apply linting advice from doc-validator tool

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-19 09:49:44 +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
Christopher Moyer
3a9d4cc688 Docs: removes dashboard images (#59619)
* removes dashboard images

* removes explore and developer docs screenshots
2022-12-01 08:32:25 -06:00
Garrett Guillotte
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