Commit Graph

544 Commits

Author SHA1 Message Date
Ashley Harrison
3e073c4dc1
Nested Folders: Update documentation (#81054)
* docs updates!

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* simplify

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2024-01-25 09:20:37 +00:00
Joey Orlando
afc3380a38
update RBAC for OnCall documentation (#80828)
* update RBAC for OnCall documentation

* Update docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md

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

* fix typo

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-01-22 16:18:39 +00:00
Piotr Jamróz
98e3a01aff
Correlations: Enable correlations feature toggle by default (#80881)
* Enable correlations by default

* Update docs
2024-01-22 09:27:11 +01: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
Eric Leijonmarck
dad50fbba9
Service Accounts: Add deprecation message for apikeys (#80354)
* add: deprecation message for apikeys

* refactor: more strong language for service accounts
2024-01-11 12:34:53 +00:00
Isabel
130d45c831
Docs: style and wording fixes (#79711)
Wording fixes
2023-12-19 12:54:00 -05:00
João Calisto
65c3bb78a6
Feature Management: add documentation (#78108)
* Feature Management: add documentation

* lint docs

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

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

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

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

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* Update docs/sources/administration/feature-management/index.md

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

* update docs

* lint

* revise docs

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Michael Mandrus <michael.mandrus@grafana.com>
2023-12-19 15:47:46 +00:00
Kristina
aa2f74a6c6
Navigation: More updates to the docs for admin subsections (#78857)
* Add more subnav to docs

* Add bold around UX text
2023-11-30 08:19:07 -06:00
Gabriel MABILLE
b6b86bb0b3
RBAC: Check plugins:install globally (#78438)
* RBAC: Check plugins:install globally

* Add disclamer to the RBACSingleOrganization config option
2023-11-21 15:09:43 +01:00
Kristina
3e5dfa2d02
Explore: Add documentation around transformations in the explore editor (#78082)
* Move explore content to explore, build out transformations content in explore area

* First round of small feedback changes

* More feedback

* More feedback tweaks

* eve edits

* Edits for the linter and a couple code clarifications

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-11-20 08:02:19 -06:00
lean.dev
48b6e894ca
Licensing: Update enterprise documentation (#78276)
* Update enterprise documentation
* Update docs/sources/administration/enterprise-licensing/_index.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-11-16 16:13:56 +02:00
Ashley Harrison
9a905b6312
Navigation: Updates to the docs for admin subsections (#77500)
updates to the docs for admin subsections
2023-11-02 14:23:19 +00:00
Andres Martinez Gotor
82a7e1229a
Bug Fix: Respect data source version when provisioning (#77428) 2023-11-02 12:27:17 +02:00
Jonathan Davies
e913160beb
docs: provisioning: Added NixOS module link. (#77273) 2023-11-01 19:06:38 +02:00
Rob Whelan
03bf6d6ed4
Docs: Add missing step to install plugin doc (#76853)
Add missing step to install plugin doc
2023-10-23 08:30:07 +01:00
Mitch Seaman
cae08aaad7
docs: minor grammar update (#76900) 2023-10-20 16:31:32 +00:00
Ieva
bfe7986ab7
Docs: add service accounts to the list of entities that can be assigned permissions (#76876)
call out that dash, folder and DS permissions can be assigned to service accounts
2023-10-20 13:53:36 +01:00
Ieva
94fec65192
RBAC: introduce a data source admin role (#75915)
* introduce data source admin role and fix frontend check

* introduce fixed roles for data source creator and team reader

* add documentation

* undo an unintended change
2023-10-19 14:36:41 +01:00
Jack Baldry
87ca68540b
Fix correlation links (#76738)
* Change link arguments to ensure that they resolve correctly regardless of version

Presently, the links take users to "latest" even if they are in other versions of documentation.
Sometimes, the destination doesn't even exist in "latest".

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

* Make myself CODEOWNER so I can ensure correct linking in the future

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

* Apply suggestions from code review

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-10-19 11:57:37 +03:00
Piotr Jamróz
1e3254bb43
Correlations: Docs update (#76508)
* First draft

* Update docs

* Update docs

* Fix a typo

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Update docs/sources/administration/correlations/use-correlations-editor-in-explore/index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Fix linting

* Fix a typo

* Update how correlations works in logs panel

* Add more context to results field

---------

Co-authored-by: Giordano Ricci <me@giordanoricci.com>
2023-10-13 19:16:23 +02:00
Piotr Jamróz
23fe8fcf5a
Correlations: Add documentation around variable exceptions (#71511) (#76510) 2023-10-13 15:32:38 +02:00
Eric Leijonmarck
f10b4bc1da
Auth: None basic role update docs (#75955)
* docs: update basic role

* update docs

* Update docs/sources/administration/user-management/manage-org-users/index.md

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

* Update docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

---------

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
2023-10-12 14:52:07 +03:00
Ishan Jain
ecbe191a30
Update Ansible Link in provision Doc (#76178) 2023-10-10 08:23:04 +01:00
Jo
4474f19836
Service Accounts: Enable adding folder, dashboard and data source permissions to service accounts (#76133)
* Add SAs to Datasource permissions

Co-authored-by: ievaVasiljeva <ieva.vasiljeva@grafana.com>

* add SAs to dashboards/folders managed permissions

* Update public/app/core/components/AccessControl/Permissions.tsx

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

* regenerate i18n

* add doc

---------

Co-authored-by: ievaVasiljeva <ieva.vasiljeva@grafana.com>
2023-10-06 17:48:13 +02:00
Misi
e1aad9c9bf
Docs: Update RBAC documentation (#75869)
* Align docs to current permissions in code

* Update permissions list

* Add example responses, fix link

* Apply suggestions from code review

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

* Update based on reviews

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-10-04 17:53:26 +02:00
Josh Hunt
33ff164339
Docs: Reword default dashboard permissions explaination (#75838)
* Docs: Reword default dashboard permissions explaination

* Update docs/sources/administration/roles-and-permissions/_index.md

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

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-10-03 19:00:00 +03:00
shaviz2000
2b83d7a168
Docs: Fix link to developing plugins (#75816)
* Docs: Fix link to developing plugins (#75788)

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

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

* Apply suggestions from code review

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-10-03 09:57:53 -05:00
Jack Baldry
4432c4c75c
Fix developer links and newly discovered spelling errors (#75875)
* Fix developer links

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

* Fix newly discovered spelling errors

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-03 13:49:27 +01:00
Joseph Perez
0e2b741fc3
Docs: Remove old plugin docs, fix URLs to go to new dev portal (#75325)
* Remove old plugin docs, add redirects to new dev portal

* Restore plugin.schema.json file

* Update docs/sources/administration/plugin-management/index.md

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

* More updates

* Cleanup links

* Update docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md

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

* fix codeowners

* Change reference links to inline links to avoid 404s

* Update docs/sources/datasources/_index.md

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

* Update docs/sources/datasources/mysql/_index.md

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

* Update docs/sources/datasources/postgres/_index.md

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

* Update docs/sources/fundamentals/timeseries-dimensions/index.md

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

* Update docs/sources/fundamentals/dashboards-overview/index.md

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

* Update docs/sources/fundamentals/dashboards-overview/index.md

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

* Update docs/sources/panels-visualizations/configure-standard-options/index.md

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

* Update docs/sources/panels-visualizations/query-transform-data/transform-data/index.md

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

* Remove grafana.com from 2 URLs

* Fix 1 more reference link

* Prettier fix

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-29 07:43:48 +01:00
Jack Baldry
7255b97d73
Fix Grafana Enterprise link (#75623)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-28 13:03:23 +01:00
Matt Davis
1f1cdaaab1
Documentation: Viewer role can arbitrarily query data sources directly (#69590)
Add docs that Viewer can query data source directly

Signed-off-by: Matt Davis <mw.davis@hotmail.co.uk>
2023-09-27 18:48:44 +02:00
brendamuir
23a873b33f
Alerting docs: fixes next and latest link errors (#75437)
* Alerting docs: fixes next and latest link errors

* fixes bracket

* more link fixes

* fixes numbering

* prettier

* Fix build errors, a broken link, and use more appropriate destination for Grafana Cloud OnCall links

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

* fixes for jacks feedback

* fixes note

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-26 16:15:32 +02:00
linoman
5aacdd9f49
Docs: No basic role documentation updates (#75110)
* Add more scenarios to the documentation

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-09-20 15:23:16 +02:00
Kyle Brandt
e3eb4a3590
docs: (fixup) link in recorded queries (#75117)
not relref for dev portal
2023-09-20 09:06:28 -04:00
Kyle Brandt
0e2ddf9864
Toggle: Enable Recorded Queries Multi support by default (#75097)
* Toggle: Enable Recorded Queries Multi support by default
2023-09-19 10:51:23 -04:00
Christopher Moyer
a7bf303832
Docs/creates backup grafana topic (#74754)
* starts to step out the backup content

* adds shared shortcode

* shares intro content

* Update docs/sources/administration/back-up-grafana/index.md

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

* updates 10 and 9.5 upgrade guides with shared content

* makes prettier

* incorporates feedback

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-09-13 10:35:04 +01:00
Isabel
a90e3f67e4
Doc: Remove Cloud Pro and Advanced references (#74050)
Removed Cloud plan references
2023-09-11 09:34:46 -04:00
Ashley Harrison
a7425f875e
Browse Dashboards: Update docs to remove reference to General folder (#74528)
* update documentation to remove mention of General folder

* update swagger-tags
2023-09-08 03:57:16 +01:00
David Harris
0884f40c8d
docs: update app plugin guidance (#74006)
Original text focusses on creation in a management topic. This change makes it more relevant to an administrator who is installing plugins.
2023-08-29 14:07:20 +01:00
Yuri Tseretyan
6b4a9d73d7
Alerting: Export contact points to check access control action instead legacy role (#71990)
* introduce a new action "alert.provisioning.secrets:read" and role "fixed:alerting.provisioning.secrets:reader"
* update alerting API authorization layer to let the user read provisioning with the new action
* let new action use decrypt flag
* add action and role to docs
2023-08-08 19:29:34 +03:00
linoman
01721d910e
Auth: Add documentation references to No Basic role (#72880)
* Update the documentation

* Add references to the documentation

* Replace X with YES in roles table
2023-08-04 16:29:24 +02:00
arunkg2787
6d4a9551cf
Update index.md (#72541)
Fixes #https://github.com/grafana/support-escalations/issues/5757

Manager Users in organisation : Added a note on default permission
2023-08-01 12:23:58 -07:00
Jack Baldry
7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

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

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

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

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

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

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

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

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

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

* Fix introduction pages products

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

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

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

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

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

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
David Harris
c4fff1c5f2
docs: update references to deprecated plugins (#71569)
* docs: update plugin management

2 of the 3 panels were deprecated and should no longer be referenced. Picked two recently updated panels to replace.

* docs: update create app

Remove reference to deprecated worldmap panel
2023-07-13 09:17:50 -07:00
Michael Mandrus
a42bab9c97
Docs: Fix minor errors in query caching documentation (#71513)
merge over changes from Larissa
2023-07-13 14:37:08 +01:00
Joseph Perez
f9df1f3051
Docs: Plugins doc reorganization, part 1 (#69864)
* Initial commit

* Prettier fixes

* Doc-validator fixes part 1

* Doc-validator fixes part 2

* More doc-validator fixes

* More doc-validator fixes

* Test

* link test

* Linnk test

* Link test

* More fixes

* More fixes

* Doc-validator fixes

* Doc-validator fixes

* fix broken link

* Fix

* Testing

* Doc fixes

* Link fixes

* Fix links

* Update docs/sources/developers/plugins/create-a-grafana-plugin/_index.md

Co-authored-by: David Harris <david.harris@grafana.com>

* Testing

* Testing

* Testing

* Testing

* Doc-validator fixes

* Doc-validator fixes

* Doc-validator fixes

* Fix broken links for plugins reorganization project

* Prettier fixes

* Prettier fixes

* Incorporate reviewer feedback

* Link fixes

* Link fixes

* Link fixes

* Link fix

* Deleted space

* Codeowners fix

* Change grafana.com links to absolute URLs for Hugo

---------

Co-authored-by: David Harris <david.harris@grafana.com>
2023-07-05 13:25:11 -05:00
Shantanu Alsi
72581a77ac
Prometheus: Add disableRecordingRules datasource config (#70903)
* Add config to toggle recording rules for Prometheus

* Add documentation for Prometheus disableRecordingRules
2023-06-29 18:58:22 +03:00
brendamuir
5159317ee7
Docs: adds evaluation doc (#70757)
* Docs: adds evaluation doc

* Adds note on classic condition

* fixes link

* fixes link

* fixes link

* fixes data source

* link fix

* fixes rbac link

* adds aliases
2023-06-28 10:38:59 +02:00
Michael Mandrus
6c25342ecb
Docs: Update query and resource caching documentation to improve clarity and add additional context (#70556)
* update caching docs

* fix validation issue

* fix missing anchors

* fix up compatible data sources section

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

Co-authored-by: Stephanie Hingtgen <stephanie.hingtgen@grafana.com>

* change one word

* change one more word

* add a little more meat to the benefits section

* remove unnecessary alias

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

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

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

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

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

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

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

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

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

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

* add link to section

* change word

* add note on benefits of resource caching

---------

Co-authored-by: Stephanie Hingtgen <stephanie.hingtgen@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-06-23 11:41:19 -04:00
tonypowa
7ea9be6832
docs: User management > invite users: adding missing navigation click (#69253)
adding missing navigation click

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-06-14 16:28:10 -04:00