Commit Graph

43 Commits

Author SHA1 Message Date
renovate[bot] c94f930950
Update dependency prettier to v3.6.2 (#108689)
* Update dependency prettier to v3.6.2

* run prettier

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
2025-07-25 17:47:44 +01:00
Isabel Matwawana e2438f338b
Docs: Reporting redesign docs (#105078) 2025-06-24 13:38:50 +00:00
Isabel Matwawana 92bb51bdda
Docs: move missing ref URI to correct page (#100131) 2025-02-05 12:08:50 -05:00
Isabel Matwawana 4009433792
Docs: fix link text (#99932) 2025-02-04 09:06:39 -05:00
Isabel Matwawana e03656669a
Docs: Updated Reporting docs (#99665)
Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>
2025-01-31 17:08:55 -05:00
Isabel Matwawana 9801a5a943
Docs: Reporting restructure (#98913)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>
2025-01-20 14:17:54 -05:00
Juan Cabanas d26d748d4a
Reporting: Change docs due to `newPDFRendering` default enablement (#98631) 2025-01-07 15:31:35 -03:00
Agnès Toulet 46974d0b60
Docs: newPDFRendering and reportingUseRawTimeRange in GA (#98450) 2025-01-06 14:20:41 +01:00
Ezequiel Victorero 06c0fa70c2
Docs: Update reporting attachment config description (#97847)
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-12-16 07:53:52 -03:00
Ezequiel Victorero 5039725da6
Snapshots: Add RBAC roles for creating and deleting (#96126) 2024-11-26 09:13:17 -03:00
Jacob Valdez e6a771cf4a
Docs: Removing outdated versioning info in create reports (#96804)
Removing outdated versioning info in create reports
2024-11-20 14:57:51 -06:00
Lucy Chen 3b36438b1c
Reporting: Add theme option (#95008)
* swagger doc

* Update doc for report settings

* Apply suggestions from code review

* swagger doc

* add doc for current theme

* update text

* wording feedback changes

* make it clearer

* update again

* update theme component

* swagger doc

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-11-14 14:45:49 -05:00
Ezequiel Victorero dd3bbbe317
Docs: Add allow list email domain configuration (#95882) 2024-11-14 10:32:01 -03: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
Vishal N 55d970ef9a
fix missing hyperlink to permissions page in docs (#94077)
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-10-09 10:42:32 -04:00
Isabel Matwawana 02f608ed05
Docs: Fix Sharing page aliases (#94118)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-10-02 10:21:43 -04:00
Isabel Matwawana 1cbe8772c2
Docs: Restructure Search content (#93636) 2024-09-24 16:12:08 -04:00
Isabel Matwawana 3087eae71d
Docs: Add max logo size (#91800) 2024-08-14 13:53:09 -04:00
Mitch Seaman 8525943699
Docs: add Zoom to Reporting docs (#90219)
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-08-09 16:28:39 -04:00
Davidson Francis 05ce16cf7b
Docs: Fix link to send report API (#90242)
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-07-09 17:08:43 -04:00
Jack Baldry c97b728c08
[docs/sources/dashboards] Replace docs/reference shortcode with ref URIs (#88085) 2024-05-22 09:55:17 +01:00
Isabel 5f41cc632e
Docs: update import troubleshoot dashboards links (#83124)
* Updated links to former manage dashboards content

* Removed links to manage dashboards and added export content to Sharing page

* Replaced grafana links with cloud docs links

* Removed trailing slash from link

* trigger CI

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-22 09:34:16 -05:00
Isabel f9dcc9ff90
Docs: add more time zone guidance (#79595)
* Created report time zone section with added guidance

* Added more information

* Updated from review suggestions

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

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

* Ran prettier

---------

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>
2024-01-16 10:52:32 -05:00
Isabel 81b465111a
Docs: replace share icon with share button (#80173)
* replaced share icon with share button

* Replaced share icon with share button

* Made fix in reporting

* trigger CI
2024-01-11 11:28:23 -05:00
Agnès Toulet 41eff02d75
Docs: Add table data in PDF (#80059)
* Docs: Add table data in PDF

* fix lint issues

* Switch to public preview

* Apply suggestions from code review

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

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2024-01-05 15:57:13 +01: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
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 a90e3f67e4
Doc: Remove Cloud Pro and Advanced references (#74050)
Removed Cloud plan references
2023-09-11 09:34:46 -04:00
Isabel 994defeeb4
docs: add product labels for reporting page (#69717)
add product labels for reporting page
2023-06-07 11:28:18 -04:00
chrisharbro 9a5262d5c8
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>
2023-05-25 11:40:41 -04: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
Isabel 4025927f7d
docs: nav updates for enterprise and reports (#66389)
nav-related text updates
2023-04-12 11:28:30 -04: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 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
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
Christopher Moyer b9a0576638
docs: Refactors remaining enterprise topics, corrects relrefs (#57707)
* moves topics, correct relrefs

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* Update docs/sources/administration/data-source-management/index.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* Update docs/sources/setup-grafana/configure-security/audit-grafana.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* Update docs/sources/setup-grafana/configure-security/configure-request-security.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* Update docs/sources/setup-grafana/configure-security/configure-team-sync.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* Update docs/sources/administration/data-source-management/index.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* Update docs/sources/administration/recorded-queries/index.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>

* removes link that goes nowhere

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>
2022-10-28 07:13:40 -05:00
Christopher Moyer 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
Christopher Moyer d0b437741e
adds 4 links to blogs (#56193) 2022-10-04 08:28:00 -05:00
Christopher Moyer 7147d17567
Docs/refactors variables topics (#54470)
* refactor and partial relref fix

* finishes variables refactor

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

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

* removes duplicate general options, adds links to general options within tasks

* adds configure variable selection options topic

* starts phase II of refactoring

* incorporates feedback, updates relrefs

* corrects final relrefs

* updates alias

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-09-09 08:38:17 -05:00
Christopher Moyer e15c8cf535
Docs: moves reporting docs per customer request (#54591)
* moves reporting docs per customer request

* corrects relrefs

* adjusts link and menutitle

* corrects typo

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-09-08 08:55:57 -05:00