public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
62,534 Commits 655 Branches 650 Tags
054e12b1aca94dea145f15475f80076c279ea20b
Commit Graph

206 Commits

Author SHA1 Message Date
Ieva
3197c5de8d RBAC: Add available scopes to RBAC docs (#93131) 
* update the list with some allowed RBAC scopes

* extend the http api docs as well

* display without bulletpoints

* add prettier ignores
 2024-09-10 08:50:03 +00:00
Pepe Cano
e87140bf75 API Docs: create Authentication page and order sidebar menu (#92900) 
* API Docs: create `Authentication` page and order sidebar menu

* fix minor typos

* Update capitalization

We don't capitalize titles as per https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/

* Update docs/sources/developers/http_api/examples/_index.md

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

* Update docs/sources/developers/http_api/authentication.md

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

---------

Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-09-06 08:17:20 +02:00
Mihai Doarna
ebd17adecf API keys: Return 410 Gone status from POST /auth/keys endpoint (#92965) 
* return 410 Gone status from POST /auth/keys endpoint

* generate swagger

* remove postAPIkeyResponse

* re-generate swagger

* remove docs for api key creation endpoint
 2024-09-05 13:10:24 +03:00
Ieva
b99d1249db Docs: Update the docs for folder creation permissions (#92703) 
* update the docs to reflect permissions needed to create subfolders

* Minor language fix

---------

Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
 2024-08-30 10:55:32 +00:00
Pepe Cano
6a29e4aecf IAM docs: Transform API keys to Migrate API keys docs (#92380) 
* IAM docs: Transform `API keys` to `Migrate API keys` docs

* Update links to `API keys` in other doc pages

* Grafana UI: update help button link

* Update OpenAPI/Swagger links

* Update docs/sources/administration/service-accounts/migrate-api-keys.md

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

* Update `relref` links to the new URL

* fix space before em dash

spaces before or after em dashes are not recommended (https://developers.google.com/style/dashes)

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
 2024-08-30 11:37:36 +02:00
Pepe Cano
fcb4b3d39e Docs: keep the HTTP API list updated (#92635) 
* Docs: keep the HTTP API list updated

* Update menu title to be consistent with the HTTP API list

* Update docs/sources/developers/http_api/preferences.md

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

* Update docs/sources/developers/http_api/snapshot.md

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

---------

Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-08-30 10:27:24 +02:00
Jack Baldry
5e89a9060b Remove all documented references to time_options (#92657) 2024-08-29 13:47:26 +01:00
Ieva
a72b557886 Docs: Extend docs with service account limitations (#92630) 
* extend docs with service account limitations

* linting

* Apply suggestions from code review

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

* PR feedback

* more PR feedback

* linting

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-08-29 09:50:11 +00:00
Eric Leijonmarck
6a19278f23 API Keys: Removal & Redirect of Create endpoint (#92144) 
* API keys: redirecting of create endpont

* update naming and using admonition

* fmt

* Apply suggestions from code review

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

---------

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
 2024-08-28 12:20:36 +01:00
Kristina
1dd830b9f1 Correlations: Migrate config type to root (#91855) 
* WIP

* Validate new field, and add value in provisioning if not defined in correct spot

* Simplify logic, use correct value

* fix tests

* Fix linter errors

* fix swagger and tests

* 😬

* Auto-generation isnt doing this..

* Fix linter

* test if nullable is the issue…

* Change structure on the frontend fields

* Try with backtick

* try programatic quoting

* Try only quote non-ints

* quoting, no backticks

* Remove debugging
 2024-08-26 08:02:48 -05:00
Ieva
5bae9f11bc Docs: Add docs for bulk updating team members (#91499) 
add docs for bulk updating team members
 2024-08-12 09:58:55 +01:00
Joao Silva
85d0e17dc4 Bookmarks: Store URLs instead of ids (#91121) 2024-07-31 13:56:39 +01:00
Joao Silva
546f4aa700 Navigation: Show list of pinned items on MegaMenu (#90280) 
* Navigation: Show list of pinned ites on the navigation

* Rename section to 'Bookmarks'

* Internationalization

* Rename everything to bookmarks

* Update public/app/core/reducers/navBarTree.ts

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>

* Ignore empty message as well

* Dont update navigation if there is an error patching

---------

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
 2024-07-22 11:43:40 +01:00
Joao Silva
9004b58851 Navigation: Backend to save navigation customization into preferences (#89783) 2024-07-03 10:40:51 +01:00
Ieva
10857c5400 Docs: Use bearer auth not basic auth in IAM doc examples (#88984) 
use bearer auth not basic auth in examples
 2024-06-11 10:35:22 +03:00
Misi
eacf6e0a4d Auth: Add org to role mappings support to GitHub integration (#88537) 
* wip: add extra tests for verifying current logic

* Add OrgRole mapping and tests

* Update docs

* Clean up

* Update docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md

Co-authored-by: Mihai Doarna <mihai.doarna@grafana.com>

* Update docs with None role

* Apply suggestions from code review

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

* Fix

* Prettier docs

* Cleanup tests

---------

Co-authored-by: Mihai Doarna <mihai.doarna@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-06-03 14:24:58 +02:00
Mihai Doarna
d83288b8c5 Docs: Improve the SSO settings API docs (#87599) 
* improve SSO settings API docs

* address feedback
 2024-05-31 11:22:54 +03:00
Jack Baldry
01cd2efbef [docs/sources/developers] Replace docs/reference shortcode with ref URIs (#88088) 2024-05-20 16:29:57 +01:00
Ezequiel Victorero
42d75ac737 Dashboards: Add feature restore dashboards backend (#83131) 
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
 2024-05-16 14:36:26 -03:00
nextMJ
309adcaa7f Typo fix in User API doc example (#81890) 
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-04-24 06:13:51 +01:00
Pepe Cano
a56a842d5f Alerting docs: fix docs/shared API to render the current version (#85526) 2024-04-03 16:04:58 +02:00
chalapat
65c0669f01 Server: Reload TLS certs without a server restart (#83589) 
* server: reload of grafana server certs when renewed without restart.

Signed-off-by: Rao, B V Chalapathi <b_v_chalapathi.rao@nokia.com>

* server: reload of grafana server certs when renewed without restart.

Signed-off-by: Rao, B V Chalapathi <b_v_chalapathi.rao@nokia.com>

* Update http_server.go

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

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

* Update http_server.go

Address the comments

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

Co-authored-by: Dan Cech <dan@aussiedan.com>

* Update http_server.go

Align the spaces

* Update http_server.go

* Update http_server.go

* Update pkg/api/http_server.go

Co-authored-by: Dan Cech <dan@aussiedan.com>

---------

Signed-off-by: Rao, B V Chalapathi <b_v_chalapathi.rao@nokia.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Dan Cech <dan@aussiedan.com>
 2024-03-22 17:13:22 +02:00
Gilles De Mey
8765c48389 Alerting: Remove legacy alerting (#83671) 
Removes legacy alerting, so long and thanks for all the fish! 🐟

---------

Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
Co-authored-by: Sonia Aguilar <soniaAguilarPeiron@users.noreply.github.com>
Co-authored-by: Armand Grillet <armandgrillet@users.noreply.github.com>
Co-authored-by: William Wernert <rwwiv@users.noreply.github.com>
Co-authored-by: Yuri Tseretyan <yuriy.tseretyan@grafana.com>
 2024-03-14 15:36:35 +01:00
Armand Grillet
e33e219a9a Remove legacy alerting docs (#84190) 2024-03-12 05:37:41 +01:00
Misi
0b71354c8d Docs: Improve SSO Settings docs (#83914) 
* Improve docs

* remove trailing slash

* Update relref
 2024-03-09 19:24:48 +01:00
Jack Baldry
2a1d4f85c7 Update links to default Grafana branch (#83025) 2024-02-29 17:08:45 +02:00
omahs
2a429cd7db Fix typos (#83621) 
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-02-29 10:47:22 +00:00
Takashi Idobe
f209a5a8b8 fix typos (#83414) 2024-02-26 10:52:44 -07:00
Arati R
ff916d9c15 Docs: Update docs for creating nested folders (#82310) 2024-02-15 15:21:01 +01:00
Lucy Chen
f2ac24f9a0 Documentation: Incorrect API example for Public Dashboard (#82335) 
fix doc
 2024-02-13 13:08:49 -05:00
Pepe Cano
9c92329bee Alerting docs: Provision alerting resources updates (#82221) 
* Alert provisioning: initial restructuring

* Fix products labels

* Restructure `Import and export Grafana Alerting resources`

* Change URL to `export-alerting-resources`

* Complete `Export alerting resources`

* Export alerting resources

* Update `configuration files` provisioning

* Terraform Provisioning

* Change to `Provision/Import/Export` terms and some notes

* Replace `config` to `configuration`

* Set (menu)Title `Export alerting resources`

* Minor change on note about `Export Alerting endpoints`

* Fix `doc-validator` issues

* Fix grammar

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

* Fix numbered lists and `Note:` without admonition

* Convert text-based notes (`Note:`) to `admonition` blocks

* Replace text-based `Note:` with adminitions

* Remove `file-provisioning` grafana-cloud links

* Update `Export alerting resources` intro

* nitpicky format order

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
 2024-02-12 10:27:18 +01:00
Clarence
2d25ce8aab chore: update typos found in docs (#81850) 2024-02-05 21:46:35 +02:00
brendamuir
ba70ee9b50 Docs: adds update to x-provenance (#81863) 
* Docs: adds update to x-provenance

* Prettier

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2024-02-05 15:06:28 +01:00
Tania
14a36b4040 Folders: Forbid performing operations on folders via dashboards HTTP API (#81264) 
* Forbid creating folders via dashboard api

* Update delete endpoint

* Update docs
 2024-02-04 01:16:19 +01:00
Jara Suárez de Puga García
b821e1621c Alerting Provisioning API: documentation Update. (#80388) 
* Update alerting_provisioning.md

* Introduction and references

* UID variable consistency formatting

* Folder and Group variables consistency formatting

* Delete Note from Contact Point section

* api/v1/provisioning/folder/:folderUid/rule-groups/:group clarifications and extension. Request #8218

* Prettier format document

* {name} to :name and format

* Comma

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

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
 2024-01-25 09:40:20 -08:00
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
Dai Nguyen
0aaebbb9a2 Docs: Updating Service Account API to include a note for Grafana Cloud instances (#80685) 
* Update Bearer Token serviceaccount.md

To update the Service Account API to include a note stating that a Bearer token for Grafana Cloud instances is needed.

* Update docs/sources/developers/http_api/serviceaccount.md

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
 2024-01-23 22:44:20 +02:00
colin-stuart
6e8e4a8b77 Auth: Add docs for the SSO Settings List endpoint (#80927) 
* add docs for SSO Settings List endpoint

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

---------

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
 2024-01-22 12:20:16 -05:00
colin-stuart
097f3c7e06 Auth: Add docs for the SSO Settings get endpoint (#80240) 
* add docs for sso-settings get endpoint

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

---------

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
 2024-01-16 13:27:28 -05:00
Pascal Zimmermann
1129f80746 docs: Adjust the update command documentation of the public dashboard endpoint (#77925) 2024-01-12 19:07:16 +02:00
Mihai Doarna
930efc3824 Auth: Add docs for the SSO Settings update endpoint (#79980) 
add docs for sso settings update endpoint
 2024-01-10 16:03:03 +02:00
Pangidoan Butar
5589c0a8f2 Updating swagger endpoint (#80008) 
The user should navigate to /swagger-ui instead of /swagger
 2024-01-09 12:07:40 -08: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
Mihai Doarna
df4eba4654 Add documentation for the SSO settings delete API method (#78521) 
add documentation for the sso settings delete API method
 2023-11-29 17:57:29 +02:00
Ryan McKinley
b8e8d84ef7 Swagger: Show k8s APIs (#78091) 2023-11-15 06:42:35 -08:00
Ieva
9c47161c14 Docs: deprecate API key reference docs and update API tutorial to use service accounts (#77429) 
* deprecate API key reference docs and update API tutorial to use service accounts

* Update create-api-tokens-for-org.md
 2023-10-31 15:29:08 +02:00
Ieva
7a9ec6b4e0 RBAC: update data source permission API reference (#76613) 
* update data source permission docs

* Update datasource_permissions.md

* Update docs/sources/developers/http_api/datasource_permissions.md

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>
 2023-10-24 16:51:12 +03:00
Jo
79b2974215 Teams: Allow Services to register deletes (#76325) 
* add team RegisterDelete

* fix-docs
 2023-10-11 15:57:03 +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
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