public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
39,455 Commits 655 Branches 650 Tags
a9873db0f94dea418511ecc953bc3d304ab95e3f
Commit Graph

238 Commits

Author SHA1 Message Date
Grot (@grafanabot)
79f1b9266d [v9.3.x] Docs: adds legacy wording to api docs (#66940) 
Docs: adds legacy wording to api docs (#66937)

adds legacy wording to api docs

(cherry picked from commit 9b529ef0cd)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
 2023-04-20 07:12:33 -04:00
Grot (@grafanabot)
46d6c7ae3a [v9.3.x] Docs: Fix 404 links in build a plugin page (#63007) 
Docs: Fix 404 links in build a plugin page (#63006)

(cherry picked from commit a2f8dd7f1f)

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
 2023-02-07 11:06:16 +00:00
Grot (@grafanabot)
5860269b82 [v9.3.x] Add canonical URL to all HTTP API docs (#62970) 
Add canonical URL to all HTTP API docs (#62957)

Facilitates mounting these docs in the Grafana Cloud documentation set
without affecting SEO.

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2023-02-06 17:21:26 +00:00
Timur Olzhabayev
7df263ff2e Fixing plugin signing docs for the current latest version (#62755) 
* Fixing plugin signing docs for the current latest version

* Deleting a file that should not have been there?
 2023-02-02 11:10:29 +01:00
ismail simsek
ead3a002df [v9.3.x] Expressions: Fixes the issue showing expressions editor (#62627) 
Expressions: Fixes the issue showing expressions editor (#62510)

* Use suggested value for uid

* update the snapshot

* use __expr__

* replace all -100 with __expr__

* update snapshot

* more changes

* revert redundant change

* Use expr.DatasourceUID where it's possible

* generate files

(cherry picked from commit 91221bc436)
 2023-01-31 14:31:33 -05:00
Grot (@grafanabot)
31971fab4f [v9.3.x] Replace ambiguous relrefs with partial URIs to prevent 404s (#62472) 
Replace ambiguous relrefs with partial URIs to prevent 404s (#62468)

* Replace ambiguous relrefs with partial URIs to prevent 404s

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

* Fix local builds that depend on latest content

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

* Fix broken relref

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

---------

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
 2023-01-30 12:53:32 +00:00
Esteban Beltran
594b5cdd95 Docs: Update publish a plugin FAQ to cover more common questions (#62… (#62063) 2023-01-25 10:04:22 +01:00
Esteban Beltran
5cf1b561cf Docs: Add source code url field description in publish a plugin document (#61132) 2023-01-09 10:49:37 +01:00
Grot (@grafanabot)
1780f86fc7 [v9.3.x] docs: fixes links (#60574) 
docs: fixes links (#60541)

fixes links

(cherry picked from commit b5834fd6d3)

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
 2022-12-20 13:05:45 -06:00
Jack Baldry
9eb271207d [v9.3.x] Use relative aliases for all non-current Grafana aliases (#60111) 
* 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 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 -z -i 's#\n *- /docs/grafana/latest/[^\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>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
 2022-12-12 08:21:41 -04:00
Grot (@grafanabot)
79d76996aa [v9.3.x] Docs: Updating sign plugin docs (#59419) 
Docs: Updating sign plugin docs (#59322)

Updating sign plugin docs

(cherry picked from commit 5a3f0e8696)

Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
 2022-11-29 09:30:11 +01:00
Timur Olzhabayev
41c491e2db Cleaning up plugin developer docs (#58596) 2022-11-10 18:36:59 +01:00
Timur Olzhabayev
5bc7f693b5 Docs: Replacing toolkit with sign-plugin (#58593) 2022-11-10 18:31:42 +01:00
Esteban Beltran
cced175ccf Docs: Replace toolkit command to scaffold plugins with create-plugin (#58462) 
* Replace command to scaffold plugin with create-plugin

* Change link text
 2022-11-09 08:15:23 -06:00
Gabriel MABILLE
101ce57a94 RBAC: Allow listing user permissions with scope (#57538) 
* RBAC: Allow listing user permissions with scope

* Add docs

* Document the api endpoint

* Update docs

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

* Split endpoint in two

* document reloadcache

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

* Fix test

* Ieva's nit.

* Simplify flag description

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>
 2022-11-02 10:48:11 +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
brendamuir
998093a280 Docs: more refactoring for alerting (#57741) 
* docs: more refactoring alerting

* performance limitations

* typo

* fix relrefs
 2022-10-27 13:21:02 +01:00
brendamuir
596b4fecb0 Docs: Refactors notifications in alerting (#57653) 
* Refactors notifications in alerting

* Fixes broken links

* adds headings

* fixes broken links

* Adds line space and intro sentences
 2022-10-26 19:07:49 +01:00
Jack Westbrook
24c04740e3 Grafana UI: Export prop types for queryfield, modal and field components (#57097) 
* chore(grafana-ui): export prop types for queryfield, modal and field components

* docs(migration-guide): add notes for react peerdependencies and additional type exposure

* Update docs/sources/developers/plugins/migration-guide.md

Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>

Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
 2022-10-17 17:54:43 +02:00
Garrett Guillotte
2bed451990 Docs: Contextualize base64 encoding in Basic Authorization (#57046) 2022-10-17 08:53:17 -07:00
Christopher Moyer
385079bea7 Docs: Basics docs refactor (#56905) 
* renames directory

* fixes relrefs
 2022-10-13 15:57:58 -05:00
Armand Grillet
83aa006c98 Add Alerting API to list of HTTP APIs (#56863) 
This link has been asked many times and is only viewable on old docs pages.
 2022-10-13 15:09:49 +02: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
Laura Benz
bc9a37ee8d Glue: Add configuration support to PATCH (#56117) 
* feat: add config to tests v0

* feat: add config to UpdateCorrelationCommand

* refactor: repair some tests

* refactor: repair another test

* refactor: repair last test

* refactor: remove possible test

* refactor: add comments

* refactor: add changes from code review

* refactor: implement more detailed patch

* feat: add tests for partial config update

* refactor: make error handling more detailed

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

Co-authored-by: Giordano Ricci <me@giordanoricci.com>
 2022-10-10 15:36:14 +02:00
brendamuir
939caa67a2 Docs: adds alertmanager overview (#56527) 
* Docs: adds alertmanager overview

* updating with georges feedback

* adds deprecation note to API docs

* update to provisioning instuctions
 2022-10-07 10:26:51 +01:00
Giordano Ricci
489b302c03 Glue: Correlations minor APIs behavior improvements (#56078) 
* add correlation config type, CorrelationConfig validator & default values

* make config required when creating correlations

* make targetUID optional, add validation for createCommand & configType

* fix tests

* update remaining tests

* fix lint error

* Update pkg/services/correlations/models.go

Co-authored-by: Piotr Jamróz <pm.jamroz@gmail.com>

* update docs

Co-authored-by: Piotr Jamróz <pm.jamroz@gmail.com>
 2022-10-04 09:39:55 +01:00
Marcus Andersson
d406e6d899 Docs: Added icon type improvements to plugin migration guide (#56075) 2022-09-30 13:17:11 +02:00
Tania
71578d0932 Docs: Document Reporting API (#55434) 
* Docs: Document reporting api

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

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

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

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

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

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

* Document the rest of endpoints

* Document more endpoints

* Fix scopes and links

* Remove rendering endpoints

* Fix status codes

* Apply review feedback

* Typo

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
 2022-09-28 17:03:43 +02: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
Tania
96cb415497 Docs: Describe applying a license (#55078) 
* Docs: Describe adding a license via API

* Add missing word
 2022-09-23 11:57:51 +02:00
Garrett Guillotte
a98a33774b Docs: Fix relrefs in access control API docs (#51940) 
* Fix relrefs in access control API docs

* Apply Prettier changes to fix CI
 2022-09-22 15:13:23 -04: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
Timur Olzhabayev
b5b41988cf Docs: Deprecating packages_api and removing it from our pipelines (#54473) 2022-09-01 18:15:44 +02:00
Timur Olzhabayev
f7302149d0 Fix: Adjusting plugin.json schema regex (#54515) 2022-09-01 15:53:38 +02: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
Ryan McKinley
b483ac322f Chore: replace React.FC<Props> with simple function component (#54123) 2022-08-24 16:54:34 -04:00
Christopher Moyer
666f84be57 refactors transformation topics (#53984) 2022-08-22 10:04:59 -05:00
Timur Olzhabayev
4ca845e479 Chore/extend plugin schema json (#53950) 
* Allowing additional parameters in tokenAuth and jwtTokenAuth
 2022-08-19 08:58:32 -04:00
Phil Z
8145caf554 Fix file extension (#53838) 2022-08-18 11:21:38 +02:00
Eve Meelan
59e638acb9 Legal: CLA formatting update (#53853) 
* Formatting

* linter
 2022-08-17 14:37:25 -05:00
Jean-Philippe Quéméner
2fef8e6f2c Alerting: add docs for file provisioning (#53101) 2022-08-17 18:53:36 +02:00
Timur Olzhabayev
12381c74f4 Adding urlparams to the routes schema (#53735) 2022-08-15 15:39:50 +02:00
Giordano Ricci
c1b30c56c9 Correlations: Add GetCorrelation(s) HTTP APIs (#52517) 
* Correlations: Get Single correlations

* Correlations: Get all correlations for given source ds

* Correlations: Get all correlations

* add tests

* add DB indices

* fix lint errors

* remove skip from tests

* use DatasourceService in test
 2022-08-11 16:58:11 +01:00
Timur Olzhabayev
2107652c3f Docs: Adding hint about healthcheck not being mandatory (#53308) 2022-08-04 18:51:52 +02:00
Giordano Ricci
09c4dbdb9f Correlations: Add UpdateCorrelation HTTP API (#52444) 
* Correlations: add UpdateCorrelation HTTP API

* handle correlation not found

* add tests

* fix lint errors

* add bad request to API spec

* change casing

* fix casing in docs

* fix tests

* update spec
 2022-08-03 14:18:51 +01:00
Harry Tennent
c56aae6f63 Docs: update annotations API docs to include required field (#52644) 
* Update annotations.md

A minor change to include the required fields when creating a new annotation via the annotations API. The error message when fields are missing is not descriptive and there is no indication in the current documentation (that I can see anyway) that would indicate these fields are required.

* Update annotations.md

Update required json body fields to only include fields that are actually required.

* Add required field in Swagger

Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
 2022-08-03 08:01:25 +00:00
Christopher Moyer
d06ea6ea0e fixes links (#52899) 2022-07-27 14:06:35 -05:00
Timur Olzhabayev
8ddf8ab6ee Updating plugin packaging documentation (#52744) 
* Updating packaging documentation

* Adding link to zipinfo manpage

* Removing unx as codespell doesnt like it
 2022-07-27 15:19:47 +02:00
Giordano Ricci
9a06b00e92 Correlations: Add DeleteCorrelation HTTP API (#51801) 
* Correlations: add DeleteCorrelation HTTP API

* fix error message copy

* add readonly check

* add source_uid in delete condition

* make path singular

* Revert "make path singular"

This reverts commit d15be89578e202e5cb64a3e964ee09521b72d87c.

* add tests

* fix lint errors

* fix lint errors

* change casing

* update spec

* Remove transaction

* change casing in param name in docs
 2022-07-27 09:07:58 +01:00