Commit Graph

37 Commits

Author SHA1 Message Date
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
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
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
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
f8240e4b0a
Docs: Refactors best practices and creates Build a dashboard section in the docs (#55101)
* starts refactor

* corrects broken relrefs
2022-09-26 10:07:24 -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
Christopher Moyer
e64009fa88
moves time series up, fixes random relrefs (#54477) 2022-08-31 10:13:07 -05:00
Christopher Moyer
948452034e
Docs/refactors manage dashboard topics (#54178)
* makes prettier

* refactors manage dashboard topics

* Apply suggestions from code review

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

* incorporates review feedback

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-08-25 11:30:07 -05:00
Christopher Moyer
ca3296da34
Docs: refactors and copy edits share dashboard topics (#53972)
* refactors and copy edits share dashboard topics

* fixes typo

* incorporates feedback

* completes splitting out reporting and playlists
2022-08-25 08:19:28 -05:00
owensmallwood
20907d0635
Adds documentation for public dashboards under the dashboards section. (#52126)
Adds documentation for public dashboards
2022-07-19 13:19:40 -06:00
Christopher Moyer
6177e433ff
updates broken relrefs, removes unneeded file (#52292) 2022-07-14 15:54:09 -07:00
Christopher Moyer
40e72c6de3
Docs: combines use dashboard content into single topic (#51527)
* combines use dashboard content into single topic

* Some minor updates

* corrects spelling

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-06-29 08:07:42 -05: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
Christopher Moyer
a568d421f8
Docs: Setup refactor (#49739)
* builds out refactored setup topics

* Automatically fix some relrefs with mv-manager

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

* Use refs for tutorials content which is outside of this repository

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

* Manually fix complicated relrefs

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

* consolidates team sync and db encryption topics

* Fix relrefs

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

* updates setup index file

* Convert TOML to YAML

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

* Add current alias for new alerting content

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

* Add current aliases to new setup-grafana and configure-security pages

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

* Update docs/sources/setup-grafana/configure-grafana/_index.md

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

* moves saml docs, updates order in TOC

* Manually fix relrefs

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

* added usage insights topics, adjusted weights

* corrected relrefs

* Fix relrefs broken in rebase

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-06-02 11:57:22 -05:00
Christopher Moyer
8c84d62e3d
Docs: combines all SAML topics into one topic (#49443)
* combines all SAML topics

* resolves merge conflicts

* makes prettier
2022-05-27 07:42:51 -05:00
Jack Baldry
b84294dd27
Convert TOML front matter to YAML (#49690)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 11:06:25 -04:00
Jack Baldry
51dfcd7d37
Add current alias to all files (#48635)
* Add aliases to all files

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

* Prettify front matter

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-17 08:24:11 -07:00
achatterjee-grafana
7311c9757a
Docs: Break down alerting HA topics (#48143)
* Initial commit

* Added some refinement to the alerting HA topics.

* Update docs/sources/administration/set-up-for-high-availability.md

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

* Updates from Chris's review. Also fixed a couple of broken relrefs

* Ran prettier

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-04-25 15:53:09 -04:00
Christopher Moyer
ea52663dd9
Docs: Combines thresholds docs into a single topic (#47985)
* start updates

* combines content into single topic

* completes draft update

* Update docs/sources/panels/configure-thresholds/_index.md

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

* incorporates feedback

* Update docs/sources/panels/configure-thresholds/_index.md

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

* Update docs/sources/panels/configure-thresholds/_index.md

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

* Update docs/sources/panels/configure-thresholds/_index.md

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

* incorporates final feedback

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-04-23 08:29:16 -05:00
achatterjee-grafana
c42b0d7498
Docs: Reorganize Dashboards and add note for escalations issue 2013 (#46902)
* Initial commit.

* Update version number

* Initial commit.

* More formatting changes. Also added URL links.

* Ran prettier.
2022-03-24 09:46:08 -04:00
Connor Lindsey
b78a67cec7
PackageJson: Prettify markdown/mdx on commit with lint-staged (#37616)
* Format md,mdx files with prettier on lint-staged

* Manually run prettier on docs/sources
2021-08-06 07:52:36 -06:00
Robby Milo
327fa124a4
cleanup shortcodes, asset paths (#34826) 2021-05-28 11:27:40 +02:00
Diana Payton
db29a8a8de
Docs: Replace next with latest in aliases (#33054) 2021-04-15 23:08:58 +02:00
Torkel Ödegaard
9873809547
Docs: Sync master docs against next version (#32602)
Co-authored-by: Robby Milo <robbymilo@gmail.com>
2021-04-12 09:42:10 +02:00
achatterjee-grafana
1bc0cff736
Share panel dashboard (#30147)
* Checking in changes.

* Change to title.

* More changes.

* More changes, removed share panel and dashboard topics from dashboards folder.

* Check in changes.

* More changes.

* Metadata and title changes.

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* removed extra space

* Update docs/sources/dashboards/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* More changes.

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* minor change.

* Updated with correct relref link.

* Changes Snapshot to snapshot.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-01-08 16:45:09 -05:00
Diana Payton
97a104598a
Docs: Remove survey (#29549)
* removed the survey code

* Update _index.md
2020-12-09 07:55:50 -08:00
Robby Milo
abee02dbcd
Docs: updates for file-based menu (#28500)
* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-11-09 12:26:49 -08:00
Diana Payton
5254a7ec5d
Docs: Add survey content (#28446)
* Update change-home-dashboard.md

* added survey code

Added survey blurb.

* Update whats-new-in-v7-3.md

* minor edits
2020-10-22 13:22:34 -07:00
ashishagarwal06
278f821282
Added Dot(.) at the end of line (#28150)
Hi - Added Dot(.) at the end of line.

Thanks,
Ashish
2020-10-13 10:53:16 -04:00
achatterjee-grafana
add777ad40
Change metadata of doc topics (#27943)
* Changes. to metadata in Manage users

* changes to install section

* Added titile

* More changes.

* Updated administration folder metadata, moved 2 files from installation folder.

* Added links to Administration landing page, other metadata changes worked out.

* Updated alerting section metadata.

* Updated metadata of Auth section. Broke index and created separate Grafana Authentication section.

* Added correct weight.

* Updated metadata for the Best practices section.

* Updated metadata in templates, broke Overview topic.

* Updated subment Variable types metadata

* Fixed yaml file and H1 description of Variables syntax topic.

* Couple more metadata changes.

* Added aliases files, as suggested by Diana.
2020-10-01 17:37:26 -04:00
Diana Payton
715f0133ee
Docs: Remove reference folder (#27944)
* Delete stack_guide_graphite.md

* moved json-model

* Moved Export and import

* Delete _index.md

* Moved Scripted dashboards

* Moved Share dashboard

* fixed links
2020-10-01 14:13:39 -07:00
DECarreras
54df058b95
Docs: Fixed lazy numbering in all documentation files (#27975) 2020-10-01 12:45:05 -04:00
Diana Payton
552e4cb84d
Docs: Remove feature folder (#27830)
* moved files out of tutorials folder

* link update

* updated weights

* moved Explore

* move files and fix links

* moved files out of features

* Revert "moved files out of features"

This reverts commit 5e44cbcc95.

* fixed links
2020-09-25 13:53:13 -07:00
Diana Payton
ff465396ab
Docs: added content to _index.md pages (#24949) 2020-05-21 08:31:06 -07:00
Diana Payton
c6da8542af
Docs: Panel inspector (#24172)
* added panel inspector content

Added inspect-panel content and placeholders for future doc architecture

* Updated topics

* Update docs/sources/panels/inspect-panel.md

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>

* Update docs/sources/panels/inspect-panel.md

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
2020-05-04 12:24:09 -07:00