Commit Graph

24 Commits

Author SHA1 Message Date
Garrett Guillotte 6a351959d2 Docs: Refactor administration docs (#50592) (#50989)
* 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

Backport of 845cebdee2 from main
2022-06-17 08:56:31 +02:00
Christopher Moyer 49b20ad76c Docs: Backport 49739 to v9.0.x (#50123)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-06-10 12:15:42 +02:00
Jack Baldry 7de6880ba4 Backport 49786 and 49207 to v9.0.x (#49932)
* 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

(cherry picked from commit 3ecee06630)

* Use ref links for external content (#49786)

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

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>
2022-05-31 10:02:35 -05:00
Christopher Moyer 4b5adfb1ba Docs: combines all SAML topics into one topic (#49443) (#49755)
* Docs: combines all SAML topics into one topic (#49443)

* combines all SAML topics

* resolves merge conflicts

* makes prettier

(cherry picked from commit 8c84d62e3d)

* Fix broken relrefs

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-31 09:27:07 -05:00
Jack Baldry ccd1270f28 Convert TOML front matter to YAML (#49729)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 13:26:26 -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
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
lean.dev b2e6ca9393 Deleting empty lines at list (#45610) 2022-02-18 11:08:52 -05:00
Christopher Moyer 023aaee929 docs: clear cache (#43471)
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-02-18 09:52:00 -03:00
lean.dev a0b29a960b Caching: Adding comment about resource caching (#45151)
Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
2022-02-18 09:49:26 -03:00
Christopher Moyer 46360ca0c3 Docs: refactored manage users and permissions content (#44343)
* initial refactor

* initial draft for teams

* restructed topics, added front matter

* modified aliases

* removes old files

* removed files

* initial refactor

* initial draft for teams

* restructed topics, added front matter

* modified aliases

* removes old files

* removed files

* final xrefs updates

* xref adjustment

* copy updates

* copy and content updates to about, add to org, add user, admin

* copy updates to remove user from org

* update org vs server admin section names, cross-link

* cross-link add and invite users to org

* add remaining cross-links between org and server admin

* add dashboard permissions table

* add permissions information to teams

* add copy invite instructions to invite management

* tweaks and link updates

* incorporated PM feedback

* fixed xrefs

* yarn prettier

* fix codespell

* combined teams and dashboard permissions content

Co-authored-by: Mitchel Seaman <mitchel.seaman@gmail.com>
2022-02-15 13:20:45 -06:00
Christopher Moyer 449c608ef1 Docs/panel refactor (#43569)
* new refactored panel docs

* fixed links

* removed xtra sharing link, added links to panel display option tasks

* fixed typo

* add aliases

* incorporate PM feedback

* intermediate commit to resolve merge conflict

* final changes to resolve merge conflicts
2022-01-18 15:06:27 -06:00
lean.dev 1ee34fb90a Fixing documentation for query caching plugin: steps duplicated (#42392) 2021-11-26 19:15:45 +01:00
Andrej Ocenas 3e47fb1432 CloudWatch Logs: Skip caching for Log queries (#39860)
* Add x-skip-cache header to queries

* Specify caching works for CW metrics
2021-10-01 09:45:37 +02: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
Mitch Seaman cd95e28c30 Docs: Document which data sources work with caching (#36561)
* Document which data sources work with caching

* add Prometheus and Loki to exclusions

* update list of built-in data sources

I checked in Grafana v8.0.4 and these were the built-in data sources that do work with query caching.

* Apply suggestions from code review

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

* alphabetize list

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-07-09 02:16:02 -06:00
Vardan Torosyan 676ddac088 Docs: Document fine-grained access control (#33563) 2021-05-20 09:53:34 -07:00
Mitch Seaman d1d118a474 Enterprise Docs: Caching: Update query caching docs for 8.0 (#34104)
* update caching docs for 8.0

* define ttl and default ttl in config docs

* Apply grammar/clarity suggestions from code review

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

* convert processes to ordered lists, reformat sentences based on feedback

* add more explicit instructions for accessing data source settings page

* clarify TTL sentence

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

* Apply re-wording from code review

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

* add permissions and backend options to caching docs

* Apply wording suggestions from code review

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

* add refresh interval info

* clarify effect of interval on caching

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-05-20 09:49:36 +02:00
Kevin Minehart 43bfa2801c Documentation: Update Grafana Enterprise caching documentation (#33398)
* update caching documentation

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-04-27 11:06:25 -05:00
Kevin Minehart 067bd5e604 add name of query caching feature flag in docs (#32215)
* add name of query caching feature flag in docs

* update caching config link
2021-03-22 15:10:19 +01:00
Kevin Minehart 6e1c5e957a Enterprise: Add Redis caching documentation (#32001)
* Document Redis cache config in Grafana Enterprise

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-03-16 15:35:52 +01:00
Kevin Minehart 34105a6db8 Docs: additional caching documentation (#31925)
* Update query-caching.md

* Update enterprise-configuration.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-03-11 22:45:16 +01:00
Mitch Seaman e23bae5ec5 Fix error in configuration options (#31745)
Configuration per data source is not available yet.
2021-03-05 22:43:43 +01:00
Mitch Seaman 04e82add68 Docs: add query caching to Enterprise docs (#31741)
* Docs: add query caching to Enterprise docs

Co-authored-by: Kevin Minehart <kmineh0151@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-03-05 14:07:07 -06:00