Commit Graph

77 Commits

Author SHA1 Message Date
Jack Baldry 244ffad99d
Fix all the old usage of admonition syntax (#106984) 2025-06-19 17:31:13 +01:00
Isabel Matwawana c611021d7d
Docs: Update experimental note (#106489) 2025-06-11 06:58:34 -04:00
Isabel Matwawana 6727f797f5
Docs: Add hidden dynamic dashboards page (#104483) 2025-05-02 15:21:29 +00:00
Marie Cruz 8dd5dbbe5c
Dashboard: remove broken play dashboard on the annotate visualizations page (#104288)
remove broken play dashboard
2025-04-22 20:26:34 +01:00
Jack Baldry 7aa028122b
Revert "Update sharing markers to use the new format" (#103681) 2025-04-14 09:53:24 +01:00
Jack Baldry ed9b649ed6
Update sharing markers to use the new format (#103470)
The new behavior is discussed in https://github.com/grafana/website/pull/25064.
The behavior lets writers include block elements like lists and continue the list in the including source.

I've removed the `panels` `ref` URI to fix the link in learning journeys.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2025-04-07 04:48:26 +01:00
Christopher Moyer e5ff56ae7b
docs/adds shared shortcode (#102946)
* adds shared shortcode

* makes prettier
2025-03-26 16:58:47 -05:00
Isabel Matwawana 18e54a9974
Docs: Add cron option for time regions (#101021) 2025-02-20 15:53:23 -05:00
Sergej-Vlasov d1dee968c3
Schema V2: Adjust quick_ranges in time settings and remove time_options (#100135)
* adjut quickRanges type in v2

* clean up unused time_options property

* remove deprecated time_options property on time picker

* add schema migration for time_options

* adjust test
2025-02-12 19:23:09 +00:00
Sergey Naumov eb2f8182c0
Dashboards: Allow custom quick time ranges specified in dashboard model (#93724)
* TimeRangePicker: allow to customize quick ranges per dashboard

* TimeRangePicker: show selected custom time range using its name

* rangeutil: add tests for describeTextRange + quickRanges

* Fix up tests, and add an extra case for hidden time ranges

* Don't construct an object to find options, add findRangeInOptions util

* fix type errors detected by TypeScript

---------

Co-authored-by: joshhunt <josh@trtr.co>
2025-02-04 14:36:28 +00:00
Isabel Matwawana feb334cdbb
Docs: update broken Play link (#98985) 2025-01-14 15:47:07 -05:00
Isabel Matwawana d0b552997d
Docs: Fix Vale linter errors (#98828) 2025-01-13 13:48:35 -05:00
Isabel Matwawana 8b374b227a
Docs: Fix broken link (#97119) 2024-11-27 11:54:08 -05:00
Isabel Matwawana f4e1f52a7a
Docs: Add note to refresh page after saving dashboards (#97112) 2024-11-27 11:14:11 -05:00
Jacob Valdez 0c73403e00
Docs: initial pruning of outdated versioning info (#95212)
* initial pruning of outdated versioning info

* removing erroneous file
2024-10-24 09:42:04 -05:00
Isabel Matwawana dbf0949ca7
Docs: update docs to reflect new sharing UI (#90630)
Co-authored-by: Juan Cabanas <juan.cabanas@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-09-25 09:42:58 -04:00
Isabel Matwawana 1cbe8772c2
Docs: Restructure Search content (#93636) 2024-09-24 16:12:08 -04:00
Jack Baldry 5e89a9060b
Remove all documented references to `time_options` (#92657) 2024-08-29 13:47:26 +01:00
Isabel Matwawana 5416444484
Docs: Update dashboard URL variables docs (#90395)
Co-authored-by: Ivan Ortega Alba <ivanortegaalba@gmail.com>
2024-07-15 09:36:10 -04:00
Isabel Matwawana 164bd86982
Docs: Edit mode updates 3 (#89565)
* Made edit mode updates in Manage library panels

* Made edit mode updates to Manage library panels

* Made edit mode updates to Inspect variables and fixed formatting

* Wording and formatting edits

* Added note about shortning process

* Reverted change to remove this file from the PR

* Made small fixes

* Fixed wording and formatting
2024-06-24 17:37:01 +02:00
Isabel Matwawana b62f8c0f19
Docs: Edit mode updates 2 (#89520) 2024-06-21 10:02:16 -04:00
Isabel Matwawana 10b6011dd7
Docs: Edit mode updates (#89438) 2024-06-20 09:53:21 -04:00
Jack Baldry c97b728c08
[docs/sources/dashboards] Replace docs/reference shortcode with ref URIs (#88085) 2024-05-22 09:55:17 +01:00
Lisa bdd288d058
Add Create annotations in panel video to the documentation (#86383)
* Add Create annotations in panel video to the documentation

* Update docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md

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

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
2024-04-18 08:14:56 -04:00
David Allen c9350a25c4
docs: add annotations play link (#86206)
* docs: add annotations play link

* PR feedback
2024-04-15 17:30:48 -04:00
Isabel Matwawana 918f122433
Docs: add tags section to dashboard settings docs (#85875)
Edited
2024-04-15 10:49:14 -04:00
David Allen eb46d85829
Docs: add best practices Play link (#86076) 2024-04-15 10:47:58 -04:00
Isabel Matwawana 3219b6f8a7
Docs: update docs for dashgpt GA G11 (#84842)
* Updated generative AI links

* Added option to use AI

* Fixed typos

* Removed public preview note and feature toggle information
2024-03-21 10:43:43 -04:00
Marie Cruz ba4470dd7d
docs: link annotation queries video to documentation (#83586) 2024-02-28 16:23:37 +01:00
Takashi Idobe f209a5a8b8
fix typos (#83414) 2024-02-26 10:52:44 -07:00
Isabel 0f47a6fa10
Docs: add RBAC for library panels (#82495)
* Added RBAC section to library panels page

* Added some library panel basic role and fixed role information

* Added remaining basic role information

* Added library panel fixed role permissions and descriptions

* Replaced 'general folder' with 'root level'

* Added library panel action definitions

* Added scope definitions

* Fixed fixed role information

* Added library panels to list of fixed roles

* Fixed typos

* Ran prettier

* Fixed links

* Fixed links again

* Updated link syntax
2024-02-15 10:29:33 -05:00
Varsha 7efa8c2840
Docs: Add copy dashboard instructions (#82155)
* Update index.md

Added description of how to copy an existing dashboard

* Moved Copy dashboard task from Import to Create page and edited for style

---------

Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
2024-02-14 09:28:48 -05:00
Isabel fb1368d1ef
Docs: restructure manage dashboards page (#81311)
* Added import and troubleshoot dashboards pages

* Moved import dashboards to build dashboards folder

* Updated import dashboards content

* Updated manage dashboards page

* Updated troublshooting dashboards page

* Finalized text for Import dashboards and moved orphaned content to Sharing page

* Made general copy edits to Troubleshooting dashboards

* Moved More examples heading and content from Troubleshooting to Import

* General copy edits to Troubleshooting

* Fixed broken links and made small copy edits

* Fixed broken link

* Removed note and replaced with plain text description of Dashboards page

Added to do for clarifying display of Shared with me section

* Deleted orphaned export content; to be rolled in later

* Copy edits

* Updated Shared with me section

* Copy edits

* Apply suggestions from code review

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

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-01-30 11:42:20 -05:00
Isabel 42c9b582e0
Docs: add saved dashboard guidance (#81406)
* Added saved dashboard guidance

* Ran prettier
2024-01-26 16:26:58 -05:00
Isabel 35ade8974f
Docs: move best practices page (#80844)
Moved best practices page
2024-01-19 08:35:13 -05:00
Denis 898f837662
Docs: add description for timepicker fields (#79527)
* Docs: add description for timepicker fields

* Update docs/sources/dashboards/build-dashboards/view-dashboard-json-model/index.md

Co-authored-by: Alexa V <239999+axelavargas@users.noreply.github.com>

* prettify

---------

Co-authored-by: Alexa V <239999+axelavargas@users.noreply.github.com>
2024-01-10 11:24:55 +01:00
Isabel 11b2f41a15
Docs: Added data source requirement for built-in annotation query (#78860)
* Docs: Added data source requirement for built-in annotation query

* Fixed wording

* Added more detailed explanation per feedback
2023-12-18 11:17:48 -05:00
Denis e6f7ad143a
Docs: add description for refresh and regex options in templating (#79441) 2023-12-18 10:31:33 -05:00
Isabel 8a650e535b
Docs: add/update frontmatter descriptions for Dashboards pages (#79357)
* Added and updated frontmatter descriptions for dashboards pages

* fixed typo

* Updated public dashboards page description
2023-12-14 14:15:55 -05:00
Isabel f1c83b3511
Docs: add missing alt text (1/3) (#79274)
* Added missing alt text

* Reworded text
2023-12-08 11:24:35 -05:00
Isabel 91784076c7
Docs: add dashgpt information (#77177)
* Added notes about AI features

* Added link to LLM content, copy edited, and fixed linting errors

* Fixed references to dashgpt setup in create dashboards, added links and fixed linting issues

* Added links to panel option config docs and fixed linting issues

* Fixed link label

* Added dashgpt info to build first dashboard

* Apply suggestions from code review

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

* Fixed links and heading level of new section

* Updated feature name

* Recast sentence

* Fixed formatting

* Added code formatting to feature flag

* Fixed link

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-27 13:55:52 -04:00
Natalia Bernarte Oses d6920a80cf
Revert "Add RBAC note to library panels" (#76531)
Revert "Add RBAC note to library panels (#76480)"

This reverts commit f3a997acde.
2023-10-13 13:36:47 +02:00
Natalia Bernarte Oses f3a997acde
Add RBAC note to library panels (#76480)
* Add RBAC note to library panels

* Update docs/sources/dashboards/build-dashboards/manage-library-panels/index.md

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

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-10-12 19:21:26 +02:00
Leanna Shippy 7562607319
[Docs] Annotate visualizations update (#76395)
There is a sentence in the [Built-in query](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/#built-in-query) section of the page that could use a "the" (emphasis added by me 😄) :
> When you copy a dashboard using the Save As feature it will get a new dashboard id, **so annotations created on source dashboard** will no longer be visible on the copy. You can still show them if you add a new Annotation Query and filter by tags. However, this only works if the annotations on the source dashboard had tags to filter by.

This PR adds "the" so the phrase reads "so annotations created on the source dashboard"
2023-10-12 14:57:06 +00:00
Jack Baldry ec774c901a
Replace use of `relref` shortcode with `docs/reference` so links work in Grafana Cloud (#75433)
* Replace use of `relref` shortcode with `docs/reference` so links work in Grafana Cloud

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

* Link to Grafana Cloud content

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-02 10:46:44 +01:00
Jack Baldry 7ef7cedc11
Prepare dashboards, panels, and visualizations for Grafana Cloud mount (#73632)
* Update dashboards pages to use `docs/reference` shortcode

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

* Update panels-visualizations pages to use `docs/reference` shortcode

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

* Use raw Markdown admonitions for contextual links

See https://discourse.gohugo.io/t/markdown-reference-links-in-shortcodes/5770/3.
Should be resolved by https://docs.google.com/document/d/19xd4CD3IrAqQqNR3xQeLfuIV-u2iNSQSBEvPZE9J4qU/edit#heading=h.5sybau7waq2q.

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

* Prefer "Warning" over "Caution"

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

* Prettier

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

* Fix some links missing destinations

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

* Fix 'time range controls' link

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

* Add missing 'HTTP APIs' link

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

* Fix dashboard links missing destinations

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

* Fix links missing destinations in panels and visualizations documentation

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

* Fix dud link

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-09-13 11:39:04 +02:00
Isabel 3bf26cc1e9
Docs: Update empty dashboard screenshot for addition of import option (#74415)
Updated empty dashboard screenshot
2023-09-06 11:11:58 -04:00
Ivan Ortega Alba 087e1658c2
Revert "Rename "Add new data source" to "Connect data"" (#74321)
Revert "Rename "Add new data source" to "Connect data" (#73688)"

This reverts commit 7543a28ae2.
2023-09-05 12:43:35 +02:00
Isabel da4fd282b3
Docs: Add guidance for Dashboard data source in repeating rows (#73967)
* Add Dashboard data source guidance

Add guidance about how the special Dashboard data source affects repeating rows

* Update link to repeating rows content

* Fixed broken relrefs and updated wording

* Updated wording for clarity

* Fixed typo
2023-08-28 16:58:29 -04:00
Torkel Ödegaard 74d453f056
DashboardSchema: Remove old unused legacy props style and timepicker.enable (#73879)
* DashboardScheam: Remove old unused legacy props style and timepicker.enable

* Update

* fix test
2023-08-28 12:18:17 +02:00