Commit Graph

182 Commits

Author SHA1 Message Date
Joe Blubaugh
41dc88bd25
Adds a description field to plugin.json's pages:role field (#62439)
* Adds a description field to plugin.json's pages:role field

There's no description of what a page object's "role" setting does. It
controls whether a page will appear in the navigation menu for a user
with a given role.

* Update plugindef.cue with comments to match documentation.

* make gen-cue
2023-02-03 14:50:24 +01:00
Marcus Efraimsson
6c02c7079f
Plugins: Update migration guide for 9.4/forwarded headers (#62505)
Update plugin migration guide in regards to v9.4 and forwarding 
of headers in grafana-plugin-sdk-go.
2023-01-31 10:33:30 +01:00
Jack Baldry
66b54e2dbd
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>
2023-01-30 12:48:12 +00:00
Esteban Beltran
cebd71cc36
Docs: Update publish a plugin FAQ to cover more common questions (#62001) 2023-01-25 08:19:32 +00:00
Timur Olzhabayev
7ebbd01688
Linking criteria and adding file and env variables access (#61830)
* Linking criteria and adding file and env variables access

* Formatting

* Update docs/sources/developers/plugins/publish-a-plugin.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2023-01-24 07:37:56 +00:00
Esteban Beltran
9c0d830e26
Docs: Add source code url field description in publish a plugin documentation (#61080) 2023-01-06 13:28:51 +01:00
Timur Olzhabayev
3ceb3edcb9
Docs: Updating plugin publishing docs (#60853)
* Updating pluign publishing docs

* Update docs/sources/developers/plugins/publish-a-plugin.md

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

* Update docs/sources/developers/plugins/publish-a-plugin.md

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

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-01-02 17:09:36 +01:00
Timur Olzhabayev
b179ac91a2
Docs: Removing outdated plugin_dev doc (#60849)
* Removing outdated plugin dev doc

* Update docs/sources/developers/plugins/legacy/_index.md

Co-authored-by: Karen Germond <110922559+karengermond@users.noreply.github.com>

Co-authored-by: Karen Germond <110922559+karengermond@users.noreply.github.com>
2023-01-02 15:20:13 +01:00
Christopher Moyer
b5834fd6d3
docs: fixes links (#60541)
fixes links
2022-12-20 08:18:56 -06:00
Kristin Laemmert
06ec8ad185
chore(docs): remove warning about (resolved) bug (#60539)
chore: remove warning about now-resolved bug
2022-12-20 09:05:15 -05:00
Andriy
bce33eeb85
Add plugin spellcheck docs (#60512) 2022-12-19 15:59:34 +01:00
Marcus Efraimsson
6478d0a5ef
Plugins: Forward user header (X-Grafana-User) in backend plugin requests (#58646)
Grafana would forward the X-Grafana-User header to backend plugin request when 
dataproxy.send_user_header is enabled. In addition, X-Grafana-User will be automatically
forwarded in outgoing HTTP requests for core/builtin HTTP datasources. 
Use grafana-plugin-sdk-go v0.147.0.

Fixes #47734

Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
2022-12-15 15:28:25 +01: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
3a9d4cc688
Docs: removes dashboard images (#59619)
* removes dashboard images

* removes explore and developer docs screenshots
2022-12-01 08:32:25 -06:00
Timur Olzhabayev
5a3f0e8696
Docs: Updating sign plugin docs (#59322)
Updating sign plugin docs
2022-11-24 19:00:33 +01:00
Marcus Andersson
5bd15026ff
Docs: How to add plugin interaction tracking (#58652)
* docs for plugin interaction tracking.

* Update docs/sources/developers/plugins/add-anonymous-usage-reporting.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

* Adding query type

* Fixed spelling issue

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2022-11-16 10:06:42 +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
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
Christopher Moyer
385079bea7
Docs: Basics docs refactor (#56905)
* renames directory

* fixes relrefs
2022-10-13 15:57:58 -05: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
Marcus Andersson
d406e6d899
Docs: Added icon type improvements to plugin migration guide (#56075) 2022-09-30 13:17:11 +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
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
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
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
Timur Olzhabayev
12381c74f4
Adding urlparams to the routes schema (#53735) 2022-08-15 15:39:50 +02: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
Michael Mandrus
278f5b131b
add secretsmanager type to plugin.json (#52408) 2022-07-18 11:02:37 -04:00
Esteban Beltran
0573df931b
Docs: Fix broken grafana plugins tutorial links (#52147)
* Fix broken grafana plugins docs links

* Update docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md

* Update docs/sources/developers/plugins/_index.md

* Update docs/sources/developers/plugins/_index.md

* Update docs/sources/developers/plugins/_index.md

* Update docs/sources/developers/plugins/add-support-for-annotations.md

* Update docs/sources/developers/plugins/add-support-for-explore-queries.md

* Update docs/sources/developers/plugins/build-a-logs-data-source-plugin.md

Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>
2022-07-14 11:52:17 -07:00
Garrett Guillotte
1c6ee69c2d
Fix relrefs in devloper docs (#51942) 2022-07-08 12:21:29 -07:00
Timur Olzhabayev
cb17f91ab5
Updating migration docs and adding hint about polystat panel (#51367) 2022-06-27 09:43:35 +02:00
Garrett Guillotte
ef26c39cbd
Docs: Fix Admin docs relrefs (#51060)
* Fix relrefs in CLI docs

* Fix relrefs in licensing docs

* Fix relrefs in AWS licensing docs

* Fix RBAC relrefs

* Fix Enterprise relrefs

* Fix data source management relrefs

* Fix server/org user management relrefs

* Remove redundant force-user-logout doc

* Fix add/remove user from org relrefs

* Fix user management relrefs

* Fix user management relrefs

* Fix link text typos

* Fix and add stats and license relrefs

* Fix index page relrefs

* Fix developer docs plugin relref to admin plugins doc

* Update docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Fix provisioning relrefs

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
2022-06-17 15:03:26 -07: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
Mark B
0a815a7777
typo fix (#50554) 2022-06-13 10:18:33 +02:00
brendamuir
e0e76f0252
Fixes term Grafana Alerting (#50404) 2022-06-08 13:35:37 +02:00
Gábor Farkas
19df6d52b7
docs: describe cookie handling in backend data source plugins (#49986)
* docs: describe cookie handling in backend data source plugins

* adjusted text
2022-06-07 12:58:46 +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
Marcus Efraimsson
a7813275a5
Plugins: Support headers field for check health (#49930) 2022-05-31 17:58:06 +02: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
Christopher Moyer
ee9ea64834
Docs: Moves http api docs to the developer docs (#49255)
* updates relrefs after move

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>

* applies weights

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* updates developer _index page

* make prettier

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-20 12:46:27 -05: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
Giordano Ricci
143810bb95
Explore: simplify support for multiple query editors (#48701)
* Explore: simplify support for multiple query editors

* CloudWatch: remove usage of deprecated plugin methods

* Apply suggestions from code review

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/developers/plugins/add-support-for-explore-queries.md

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/developers/plugins/add-support-for-explore-queries.md

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* run prettier

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>
2022-05-05 10:36:50 +01:00