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
3a9d4cc688
Docs: removes dashboard images ( #59619 )
...
* removes dashboard images
* removes explore and developer docs screenshots
2022-12-01 08:32:25 -06:00
5a3f0e8696
Docs: Updating sign plugin docs ( #59322 )
...
Updating sign plugin docs
2022-11-24 19:00:33 +01:00
b0fc736e7a
Remove Annotations API version reference ( #57057 )
...
Remove minimum version reference in Annotations API docs, since docs are versioned and this feature has been released for years.
2022-11-21 10:07:59 +00:00
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
41c491e2db
Cleaning up plugin developer docs ( #58596 )
2022-11-10 18:36:59 +01:00
5bc7f693b5
Docs: Replacing toolkit with sign-plugin ( #58593 )
2022-11-10 18:31:42 +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
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
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
998093a280
Docs: more refactoring for alerting ( #57741 )
...
* docs: more refactoring alerting
* performance limitations
* typo
* fix relrefs
2022-10-27 13:21:02 +01:00
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
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
2bed451990
Docs: Contextualize base64 encoding in Basic Authorization ( #57046 )
2022-10-17 08:53:17 -07:00
385079bea7
Docs: Basics docs refactor ( #56905 )
...
* renames directory
* fixes relrefs
2022-10-13 15:57:58 -05:00
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
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
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
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
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
d406e6d899
Docs: Added icon type improvements to plugin migration guide ( #56075 )
2022-09-30 13:17:11 +02:00
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
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
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
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
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
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
b5b41988cf
Docs: Deprecating packages_api and removing it from our pipelines ( #54473 )
2022-09-01 18:15:44 +02:00
f7302149d0
Fix: Adjusting plugin.json schema regex ( #54515 )
2022-09-01 15:53:38 +02:00
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
b483ac322f
Chore: replace React.FC<Props> with simple function component ( #54123 )
2022-08-24 16:54:34 -04:00
666f84be57
refactors transformation topics ( #53984 )
2022-08-22 10:04:59 -05:00
4ca845e479
Chore/extend plugin schema json ( #53950 )
...
* Allowing additional parameters in tokenAuth and jwtTokenAuth
2022-08-19 08:58:32 -04:00
8145caf554
Fix file extension ( #53838 )
2022-08-18 11:21:38 +02:00
59e638acb9
Legal: CLA formatting update ( #53853 )
...
* Formatting
* linter
2022-08-17 14:37:25 -05:00
2fef8e6f2c
Alerting: add docs for file provisioning ( #53101 )
2022-08-17 18:53:36 +02:00
12381c74f4
Adding urlparams to the routes schema ( #53735 )
2022-08-15 15:39:50 +02:00
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
2107652c3f
Docs: Adding hint about healthcheck not being mandatory ( #53308 )
2022-08-04 18:51:52 +02:00
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
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
d06ea6ea0e
fixes links ( #52899 )
2022-07-27 14:06:35 -05:00
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
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
4b2144fe40
Correlations: change casing of *UID properties ( #52836 )
...
* Correlations: change casing of *UID properties
* add link to correlations HTTP API
2022-07-27 07:01:46 +01:00
86283bb99e
Chore: Rename dashboardUID to dashboardUIDs in search endpoint and up… ( #52766 )
...
* Chore: Rename dashboardUID to dashboardUIDs in search endpoint and update doc
* make it backward compatible
2022-07-26 22:28:14 -04:00
7da0a6d3ce
Chore: Add dashboard UID as query parameter of Get annotation endpoint ( #52764 )
...
* Chore: Add dashboard uid as query parameter of Get annotation endpoint
* Update pkg/api/annotations.go
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
* update the dashboarUID
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
2022-07-26 21:52:34 -04:00
e947910910
Service accounts: update docs ( #52734 )
...
* update the docs
* Update docs/sources/administration/service-accounts/_index.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-07-26 09:44:12 +01:00
ac502e5013
Chore: add dashboarduid in the connection endpoint response ( #52761 )
...
* Chore: add dashboarduid in the connection endpoint response
* add uid of dashboard in the markdown
2022-07-25 18:55:28 -04:00
5ce4baf6f5
Correlations: Add CreateCorrelation HTTP API ( #51630 )
...
* Correlations: add migration
* Correlations: Add CreateCorrelation API
* Correlations: Make correlations work with provisioning
* Handle version changes
* Fix lining error
* lint fixes
* rebuild betterer results
* add a UID to each correlation
* Fix lint errors
* add docs
* better wording in API docs
* remove leftover comment
* handle ds updates
* Fix error message typo
* add bad data test
* make correlations a separate table
* skip readonly check when provisioning correlations
* delete stale correlations when datasources are deleted
* restore provisioned readonly ds
* publish deletion event with full data
* generate swagger and HTTP API docs
* apply source datasource permission to create correlation API
* Fix tests & lint errors
* ignore empty deletion events
* fix last lint errors
* fix more lint error
* Only publish deletion event if datasource was actually deleted
* delete DS provisioning deletes correlations, added & fixed tests
* Fix unmarshalling tests
* Fix linting errors
* Fix deltion event tests
* fix small linting error
* fix lint errors
* update betterer
* fix test
* make path singular
* Revert "make path singular"
This reverts commit 420c3d315e83ef9a7154766c812a24c7b02fc104.
* add integration tests
* remove unneeded id from correlations table
* update spec
* update leftover references to CorrelationDTO
* fix tests
* cleanup tests
* fix lint error
2022-07-25 15:19:07 +01:00
