f3ba16d3b7
Tidying up the Grafana setup documentation ( #93860 )
2024-09-27 15:57:38 +00:00
26a3e70cfa
Docs: Table visualization refactor ( #93633 )
2024-09-25 13:06:33 -04:00
a2859de5b6
Alerting docs: updates duration type to string ( #93532 )
...
* Alerting docs: updates duration type to string
* ran prettier
2024-09-20 14:55:44 +02:00
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
f063088188
[DOC] Update TraceQL query editor doc ( #91910 )
...
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-08-27 14:49:49 +01:00
a0e1028ae6
Alerting docs: include `Grafana Alerting API` as one option to manage… ( #91593 )
...
Alerting docs: include `Grafana Alerting API` as one option to manage Data sources-mangaged resources
2024-08-20 00:03:07 +02:00
db33df5041
Alerting: Template API to return errutil errors ( #91821 )
2024-08-13 10:59:19 -04:00
b03a709500
[DOC] Update Tempo and Pyroscope data source doc ( #91704 )
...
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2024-08-13 10:39:55 -04:00
1108a00668
Alerting: Support for optimistic concurrency in priovisioning Tempate API ( #91195 )
...
* support optimistic concurrency in template service
* update request handler to get version from query parameter
* return not found if a new template is set with version
* update PUT api to set version
* update documentation + for mute timings
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-08-09 11:40:07 -04:00
ce14d79064
[DOC] Add Streaming doc for Tempo data source ( #91432 )
...
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-08-06 18:00:16 +01:00
114d87bf61
Alerting docs: Update `Alerting provisioning HTTP API` ( #91493 )
...
* Remove `Consumes` info
* Remove `top-level` content negotiation/Produces
* Remove `Version Information`
* Better distinguish between Grafana and Data source managed alerts
* Add note for Enterprise RBAC permissions
* Minor changes for clarity
* Add examples
* Minor copy change
* Update docs/sources/shared/alerts/alerting_provisioning.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/shared/alerts/alerting_provisioning.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/shared/alerts/alerting_provisioning.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-08-05 16:47:48 +02:00
21e40908fe
Docs: time series overall edit ( #91220 )
...
Co-authored-by: Nathan Marrs <nathanielmarrs@gmail.com>
Co-authored-by: Nathan Marrs <nathanielmarrs@gmail.com>
2024-08-01 16:58:53 -04:00
8c4c3103df
Docs: added heading identifiers ( #90564 )
2024-07-19 09:40:01 -04:00
e3150b4eb8
Docs: Refactor time series page - part 1 ( #90098 )
...
Co-authored-by: nmarrs <nathanielmarrs@gmail.com>
2024-07-18 13:19:06 -04:00
5416444484
Docs: Update dashboard URL variables docs ( #90395 )
...
Co-authored-by: Ivan Ortega Alba <ivanortegaalba@gmail.com>
2024-07-15 09:36:10 -04:00
92ad6c71d1
alerting:mute-timings>api ( #89902 )
...
* alerting:mute-timings>api
* added type go-type
* all pretty
2024-07-02 10:46:18 +00:00
3edca2e2fd
Docs: Add tooltip options to histogram v11.2 ( #89863 )
...
Co-authored-by: Adela Almasan <88068998+adela-almasan@users.noreply.github.com>
2024-06-27 17:16:57 -04:00
9f04b6d6a8
Add note for streaming TraceQL results for GET and/or Tempo setups using intermediary proxies ( #89251 )
...
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
2024-06-21 09:12:08 -04:00
0cc67bb93d
alerting: notes on label matchers ( #89269 )
...
* alerting: notes on label matchers
* routing clarification
* Update docs/sources/alerting/alerting-rules/templating-labels-annotations.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-18 09:22:23 +02:00
4b55776256
Docs: Add `maxWidth` to tooltip docs ( #88932 )
2024-06-07 14:36:48 -05:00
2c7569e004
Docs: Fix two broken links to plugin-tools/reference ( #87278 )
...
Fix two broken links
2024-06-03 10:58:23 +02:00
3d7fc8c927
Alerting docs: Update Intro - alert rule labels and annotations ( #88230 )
...
* Update `Labels & Annotations`
* Complete labels and annotations
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-24 10:09:35 +02:00
01d5744433
Alerting docs: adds note on provisioning to main page ( #88264 )
2024-05-24 09:44:21 +02:00
f8d9f8541b
Docs: add panel options shared content ( #87258 )
...
* Added panel options shared file
* Added panel options shared file to visualizations pages
* Fixed version interpolation syntax and added Cloud links
* Fixed heading level of title
2024-05-02 14:17:23 -04:00
90b594e998
Docs: add standard options shared content ( #87199 )
...
* Added standard options shared file
* Added missing option to shared file and added shared file link to visualizations pages
* Fixed links
2024-05-01 18:30:24 -04:00
d5cfcc8187
Docs: add field overrides shared content ( #87197 )
...
* Added field overrides shared file
* Added link to overrides file in visualizations pages
* ihm/010524-field-override-shared-content/ run lint
---------
Co-authored-by: jev forsberg <jev.forsberg@grafana.com>
2024-05-01 18:10:06 -04:00
1ef0e240e9
Docs: Add data links shared content ( #86893 )
...
* Added data link options shared file and added file to relevant visualizations
* Updated some text and links in canvas
* Added shared file to xy chart
* Fixed list of visualizations using shared file
* Removed unneeded level offset
* Removed future tense
* Update data links description
* Updated wording
* Removed redundant sentence
2024-05-01 16:51:12 -04:00
406fe8c85a
Docs: Add thresholds shared content ( #87009 )
...
* Added thresholds shared files
* Added shared files to visualizations and updated shared files
* Removed future tense
* Fixed prettier
2024-04-30 16:33:31 -04:00
dad3069594
Docs: add legends shared content ( #86814 )
...
* Updated shared file name and added missing options
* Added legend options 1 shared file to relevant visualizations
* Updated shared file name and corrected options
* Added legend options 2 shared file to relevant visualizations
* Updated legend content for heatmap and pie chart
* Added where shared legend files are used in each file
* Moved intro text out of viz pages into legend options shared files
* Added reasoning to front matter of shared files
* Added reasoning to front matter of shared files
* Fixed version interpolation and added cloud links
* Updated links in shared files
2024-04-30 15:40:07 -04:00
d5fde99c6d
Docs: Add value mappings shared content ( #86996 )
...
* Added value mappings shared file
* Fixed name of file
* Fixed list of visualizations using shared file
* Added shared file to visualizations
* Updated shared file and added to canvas
* Updated shared file intro text
* Removed future tense
2024-04-26 14:32:01 -04:00
0e81fdffbe
Docs: add tooltips shared content ( #86553 )
...
* Replaced shared tooltips file with text in xy chart
* Added tooltip info for heatmap
* Updated tooltip shared files, renamed one file, updated configure tooltips
* updated tooltip shared file paths
* Added tooltips shared files in relevant visualizations
* Added where shared file is used in tooltip-options-1
* Added where shared file is used in tooltip-options-2
* Added intro text and justifications to shared files
* Removed tooltips intro text from visualizations with shared files
* Added names of files to comments in shared files
2024-04-24 12:40:27 -04:00
d6e84dbf0a
[DOC] Update the traces to profile content based upon SDK updates ( #86628 )
...
Update the traces to profile content based upon SDK updates
2024-04-19 14:17:11 -05:00
441118e506
Alerting docs: include `hcl` format in `/alert-rules/:uid/export` endpoint ( #85432 )
2024-04-08 16:01:18 +02:00
0d7834c7f7
Docs: Add xy chart docs ( #81980 )
...
* Added xy chart page and added link to main visualizations page
* Added options
* Updated Axis options section and added doc ref links
* Added new shared files for tooltip and legend options and added them to xy chart
* Added Other visualization options section, docs refs, and updated Cloud links
* Fixed links
* Added option descriptions, hero image, content notes, and removed placeholder heading
* Apply suggestions from code review
* Added collapsible sections for series mapping modes
* Added Cloud links and fixed link text
* Added notes
* Updated series mapping descriptions
* Updated Auto series mapping options
* Updated manual section and restructured page
* Copy edits
* copy edits
* Added description
* Clarifying supported data info
* Copy edits from review
* Fixed typo
* Copy edits
* Fixed links
2024-04-04 16:30:14 -04:00
e138ae3eb9
Alerting: Improve openAPI specification and docs for export endpoints ( #85008 )
2024-03-22 18:25:27 +02:00
e1d9aa5a7b
Alerting docs: document HTTP API to create templates ( #84055 )
2024-03-14 09:01:13 +01:00
d767c4f694
Remove hanging text block from traces->profiles docs ( #83859 )
...
Remove hanging text block
This is causing the page to render a bit oddly on the website
2024-03-06 09:33:09 +00:00
57935250fd
[DOC] Add profile-traces intro material; update Pyroscope data source info ( #83739 )
...
* Add profile-traces intro material; update Pyroscope data source info
* Apply suggestions from code review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Updates and file rename from review
* Add PYROSCOPE_VERSION
* Apply suggestions from code review
* Format tables
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Apply suggestions from code review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
* Apply suggestions from code review
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
2024-03-04 10:03:33 -05:00
244589d7ea
Alerting docs: document `mute-timings` export endpoints ( #83797 )
2024-03-04 10:50:44 +01:00
e26cd8614d
Docs: fix config file info in upgrade guide ( #83273 )
...
* Updated incorrect custom config file names and locations
* Corrected default config file name
* Updated more config file info
* Apply suggestions from code review
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
* Reverted change
* Fixed default config file info, added second custom file option, and added note about file locations
* Added file path for second custom option
* Apply suggestion from review
Co-authored-by: Usman Ahmad <usman.ahmad@grafana.com>
* Apply suggestion from review
Co-authored-by: Usman Ahmad <usman.ahmad@grafana.com>
* Apply suggestions from review
Co-authored-by: Usman Ahmad <usman.ahmad@grafana.com>
* Apply suggestion from review
* Add version interpolation syntax
* Updated wording
* Ran prettier
---------
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
Co-authored-by: Usman Ahmad <usman.ahmad@grafana.com>
2024-02-29 09:39:25 -05:00
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
eb25b669c6
Alerting docs: update Alerting Provisioning ( #83376 )
...
* Minor updates to Provisioning Index page
* Add instructions to export other alerting resources
* Edit example provisioning a `template` via config file
* Add `Resource` column to the `Export API endpoints` table
* Sort the `export` endpoint on the table in `Alerting Provisioning HTTP API`
* Minor updates for clarity to `Use configuration files to provision` docs
* Add `More examples` in Terraform Provisioning docs
* File provisioning: rename `Useful Links` section to `More examples`
* Minor grammar change
* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Address requested changes to `Export` docs
* export: Minor grammar change
* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Fix `doc-validator` issue with relative link
* Use patch fixed version of doc-validator that better supports docs/reference destinations
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-27 16:22:24 +01:00
62163f8844
[DOC] Tempo data source: fix broken link and clarify traces to profile ( #83135 )
...
* Update Tempo data source to fix broken link
* Correct profiles content
* Move explanation table up
* Chagnes from prettier
* Resolve conflict
2024-02-22 16:22:00 -06:00
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
815e61258c
[DOC] Update Pyroscope data source ( #82130 )
...
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-12 08:34:36 +00:00
96301ce533
Tempo: Trace to metrics docs ( #81548 )
...
* Trace to metrics docs and share variables that can be used in query section
* Update text
* Add span start/end
* Update docs/sources/shared/datasources/tempo-traces-to-profiles.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/datasources/tempo/configure-tempo-data-source.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/datasources/tempo/configure-tempo-data-source.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update text
* Update docs/sources/datasources/tempo/configure-tempo-data-source.md
---------
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
2024-02-06 08:58:08 +00:00
da8eb8faa5
[DOC] Fix style issues and add videos to tracing and profiling shared files ( #81215 )
...
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Ryan Perry <Rperry2174@gmail.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
2024-01-30 10:41:33 +00:00
467f293948
Tempo: Upgrade trace to profiles docs ( #81002 )
...
* Update docs to use embedded flame graph image
* Update headings
* Update link type
* Add embedded flame graph content
* Minor text changes
* Add provisioning example
* Move configure table into section
* Add configure section
* Update provisioning example
* Update docs/sources/shared/datasources/tempo-traces-to-profiles.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update docs/sources/shared/datasources/tempo-traces-to-profiles.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* Update wording
---------
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
2024-01-26 10:56:46 +00:00
c14ef43691
Tempo TraceQl Editor update request #8382 ( #80112 )
...
* Tempo TraceQl Editor update request #8382
* Docs: Typo
* Docs: Typo 2 codespell lint
* Update docs/sources/shared/datasources/tempo-editor-traceql.md
* Update docs/sources/shared/datasources/tempo-editor-traceql.md
* Update docs/sources/shared/datasources/tempo-editor-traceql.md
---------
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2024-01-23 07:04:04 -08:00
f3c64a7337
Tempo: Remove profiling toggles ( #80792 )
...
* Remove traceToProfiles toggle
* Remove tracesEmbeddedFlameGraph toggle
* Remove superfluous import
* Update ConfigDescriptionLink
* Update getting of profiles from standalone build PR
2024-01-22 14:21:14 +00:00
Timothee
Isabel Matwawana
brendamuir
Pepe Cano
Kim Nylander
Yuri Tseretyan
antonio
Adela Almasan
Joseph Perez
Jennifer Villa
omahs
Joey
Jara Suárez de Puga García