13be068919
Docs: Plugin doc review for chunk 1-A ( #67070 )
...
* Plugin doc review for chunk 1-A
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Group of fixes in response to review comments
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Updates for review comments
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Fixed extra space
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Additional doc fixes
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* More doc fixes
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Fixes from doc review
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Doc review fixes
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* More changes from doc review
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Fix links and relrefs using doc-validator advice
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Publishing criteria update
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Markdown fix
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Fixes
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Testing
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Testing
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Testing
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Link fix
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Prettier
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Fix to publishing criteria
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Doc fix
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Doc fix
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Doc fix
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/build-a-logs-data-source-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/get-started-with-plugins/_index.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/publish-a-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/publish-a-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/publish-a-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/developers/plugins/sign-a-plugin.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Prettier
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
---------
Signed-off-by: Joe Perez <joseph.perez@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
2023-05-08 16:33:39 -05:00
d1f1beaef9
Docs: Add distributed tracing plugin developer guide ( #65898 )
...
* Docs: Add plugin developer guide on distributed tracing
* Docs: Fix typo
* Docs: Plugins: Tracing: Address TODOs and other changes
* Docs: Plugins: Tracing: Fix typo
* Docs: Plugins: Tracing: Add note about min SDK version and update command
* Docs: Plugins: Tracing: Fix some typos, rephrase some sentences
* Docs: Plugins: Traacing: Removed manual instance management instructions
* Update docs/sources/developers/plugins/add-distributed-tracing-for-backend-plugins.md
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
* Docs: Plugins: Tracing: Use markdown instead of HTML
---------
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2023-04-14 12:18:07 +02:00
92ee03db78
Docs: Pinning to latest for grafana plugin tools ( #64140 )
...
Pinning to latest for grafana plugin tools
2023-03-03 15:07:35 +01:00
a2f8dd7f1f
Docs: Fix 404 links in build a plugin page ( #63006 )
2023-02-07 12:01:44 +01:00
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
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
41c491e2db
Cleaning up plugin developer docs ( #58596 )
2022-11-10 18:36:59 +01:00
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
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
1c6ee69c2d
Fix relrefs in devloper docs ( #51942 )
2022-07-08 12:21:29 -07:00
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
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
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
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
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
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
f220b24d9d
Docs: Development with local Grafana ( #47121 )
2022-04-01 15:23:23 +02:00
e888a40531
Plugins: Add notices to docs to prevent NPX commands from hanging ( #44043 )
...
* docs(plugins): add notice about npm 7 flag to prevent commands from hanging
* Apply suggestions from code review
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-01-17 15:58:36 +01:00
c4b21f7b51
Removed packahes_api relrefs. ( #42017 )
2021-11-22 16:58:51 -05:00
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
db29a8a8de
Docs: Replace next with latest in aliases ( #33054 )
2021-04-15 23:08:58 +02:00
9873809547
Docs: Sync master docs against next version ( #32602 )
...
Co-authored-by: Robby Milo <robbymilo@gmail.com>
2021-04-12 09:42:10 +02:00
b9b6af9491
Dashboards: Adds cheat sheet toggle to supported query editors ( #28857 )
...
* Dashboards: Adds cheat sheet toggle to supported query editors
2021-01-19 23:52:09 +01:00
97a104598a
Docs: Remove survey ( #29549 )
...
* removed the survey code
* Update _index.md
2020-12-09 07:55:50 -08:00
c52fd933f6
Docs: Fix broken link for plugins ( #29346 )
2020-12-01 13:52:32 +01:00
81d30615b4
Docs: fix relref ( #28977 )
2020-11-10 14:38:45 +01:00
abee02dbcd
Docs: updates for file-based menu ( #28500 )
...
* initial
* cleanup
* remove bad aliases
* cleanup, fix links
* add docs-file-based-command
* update docs
* update readme
* fix broken links
* fix spelling
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-11-09 12:26:49 -08:00
f39a8d630b
Docs: Plugin signing docs ( #28671 )
...
* WIP
* Update plugin signing docs
* Fix review comments
2020-11-05 16:40:33 +01:00
5254a7ec5d
Docs: Add survey content ( #28446 )
...
* Update change-home-dashboard.md
* added survey code
Added survey blurb.
* Update whats-new-in-v7-3.md
* minor edits
2020-10-22 13:22:34 -07:00
3b8701a35d
Docs: Add reference to plugin examples ( #27809 )
...
* Add reference to plugin examples
* Remove unintended whitespace
2020-09-25 16:47:52 +02:00
e6453198a9
Docs: Add data frames plugin guide ( #27430 )
2020-09-16 14:39:46 +02:00
fa4084f90a
Docs: Add plugins guide on error handling ( #26518 )
2020-07-31 07:07:03 -07:00
3a57ba20cf
Docs: Update _index.md ( #26028 )
2020-07-06 13:07:54 -07:00
45bbee2dea
Update _index.md
2020-07-02 15:03:03 -04:00
78996516af
Docs: Update configuration.md ( #25707 )
...
* Update configuration.md
* moved configuration.md to administration folder
* updated links
* Added quota section
* Update upgrading.md
* Update configuration.md
* Update configuration.md
* Update configuration.md
* Updating links
* Update configuration.md
* Update configuration.md
* Update configuration.md
Reworked the security options
* Update configuration.md
* Update configuration.md
* Update provisioning.md
* Update provisioning.md
* Update configuration.md
* Update configuration.md
* Update docs/sources/administration/configuration.md
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2020-06-23 09:56:44 -07:00
79fea5df2a
Docs: Update guide on authenticating data source plugins ( #24884 )
...
* Update guide on authenticating data source plugins
* Fix broken references
2020-06-11 12:12:27 +02:00
6b29c11776
Add guide for streaming data sources ( #24786 )
2020-05-19 09:05:48 +02:00
77148ef616
Docs: Backend plugins conceptual overview (first iteration) ( #24668 )
...
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Marcus Olsson <accounts+github@marcus.se.net>
2020-05-14 13:21:26 +02:00
c1b057a57d
Docs: Add linking topics ( #24408 )
...
* Create _index.md
* Create linking-overview
* Create dashboard-links
* Update linking-overview
* Added content, renamed files
* Moved and renamed files
* renamed file
* Update link-panels.md
* Added URL variables and changed content
* Delete links.md
Content moved to other files
* Update menu.yaml
* Delete timerange.md
Content moved to URL variables
* content updates
* updated links
* Revert "Delete timerange.md"
This reverts commit 662672c03be111bb446b53d1c1775d9b248a6f2f.
* Create data-links.md
* Revert "Delete links.md"
This reverts commit c83ba7eed3d6693b66b700ffe9530354297958f2.
* content updates
* Added data links topic
* Update _index.md
* Update _index.md
* Update docs/sources/linking/data-links.md
Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
* Update data-links.md
* Update data-links.md
Co-authored-by: Daniel Lee <dan.limerick@gmail.com>
Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
2020-05-13 06:08:11 -07:00
75de6165fc
Docs: Add guides to plugin overview ( #24560 )
...
* Add guides to plugin overview
* Update docs/sources/developers/plugins/_index.md
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-12 23:31:36 +02:00
fc0c717bfb
Restructure plugin docs ( #24381 )
2020-05-07 18:45:52 +02:00
