Commit Graph

94 Commits

Author SHA1 Message Date
Simon Podlipsky 464a61352c
Docs: Add HAProxy rewrite information considering `serve_from_sub_path` setting (#80062)
* docs: specify HAProxy rewrite considering `serve_from_sub_path` setting

* Update docs/sources/tutorials/run-grafana-behind-a-proxy/index.md

Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>

* Update docs/sources/tutorials/run-grafana-behind-a-proxy/index.md

Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>

* Update docs/sources/tutorials/run-grafana-behind-a-proxy/index.md

Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>

* Update docs/sources/tutorials/run-grafana-behind-a-proxy/index.md

* Update docs/sources/tutorials/run-grafana-behind-a-proxy/index.md

Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>

---------

Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
2024-01-30 01:30:57 +02:00
tonypowa 3a7b745278
fixed py code indentation pt.2 (#80975)
* fixed py code indentation

* pretty

* 2nd code snippet update

* pretty

* pretty
2024-01-22 14:22:33 +01:00
tonypowa a7e9408433
fixed py code indentation (#80966)
* fixed py code indentation

* pretty
2024-01-22 12:55:28 +01:00
Clayton Cornell d68bf3d715
Update rasp pi install tutorial, correct APT install steps (#80236)
* Update the Linux install steps

* Minor updates to text
2024-01-11 08:30:35 -08:00
tonypowa c400899f77
grafana fundamentals: update (#78292)
* grafana fundamentals: update

* run prettier
2023-12-26 11:10:26 +02:00
Sonia Aguilar 0abfc3b6be
Alerting: Update 'Create alert' to 'New alert rule' in the panel and docs (#76950)
* Update 'Create alert' to 'New alert rule' in the panel and docs

* Fix test
2023-11-02 17:33:53 +01:00
Stephen Yeargin c73a2bde9c
Documentation: Update Hubot Integration documentation (#76925)
* Update Hubot Integration documentation

The script package has improved over the years to allow for direct uploading to Slack, etc. This updates the documentation to reflect that.

* Apply suggestions from code review

Co-authored-by: lwandz13 <126723338+lwandz13@users.noreply.github.com>

---------

Co-authored-by: lwandz13 <126723338+lwandz13@users.noreply.github.com>
2023-11-02 15:50:32 +02:00
Melori Arellano 5753024ad5
Logs Alerting Tutorial: Fix small formatting issue on code block (#74780)
Update index.md

Change code block formatting for website
2023-09-13 09:57:42 +02:00
Melori Arellano 5d89c15851
Alerting with Loki tutorial (#72704)
* Add new tutorial for alerting with Logs

* Begin formatting the tutorial

* Formatted the tutorial with markdown

* Small edits

* Updating for version 10

* Edits for Grafana 10 & formatting

* Deleted rough draft that I accidentally added.

* Update docs/sources/tutorials/create-alerts-with-logs/index.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Update docs/sources/tutorials/create-alerts-with-logs/index.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Apply suggestions from code review

Commit suggestions from reviewer

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Updated to use instant query

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-09-11 18:14:14 +03:00
Torkel Ödegaard 74d453f056
DashboardSchema: Remove old unused legacy props style and timepicker.enable (#73879)
* DashboardScheam: Remove old unused legacy props style and timepicker.enable

* Update

* fix test
2023-08-28 12:18:17 +02:00
C M cc1ea31616
Docs: Fixed Grafana Fundamentals tutorial to match updated UI (#73168)
* Update index.md

The word `Configuration` was used to describe an action for getting started, when the actual UI has the word `Administration` and not Configuration. Updated the docs to reflect the actual environment created.

* Update index.md

Updated the tutorial to match the current UI options

* Made copy edits for styling and consistency with Cloud fundamentals tutorial

Made some copy edits to match our style guide and to make this tutorial a bit more consistent with the Cloud version. Also added the step for updating the legend back to the build dashboards section.

* Ran linter

* Edited text to match updated UI

Made edits to match UI behaviour as well as some further style edits.

* Made final copy edits

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
2023-08-16 13:51:53 -04:00
Jack Baldry 7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

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

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

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

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

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

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

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

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

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

* Fix introduction pages products

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

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

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

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

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

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
Misi 54f1c8a40d
Docs: Add note for setting root_url in case of NGINX TLS termination (#71287)
* Add note for setting root_url in case of TLS termination

* Update docs/sources/tutorials/run-grafana-behind-a-proxy/index.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-07-11 17:29:26 +02:00
Joseph Perez f9df1f3051
Docs: Plugins doc reorganization, part 1 (#69864)
* Initial commit

* Prettier fixes

* Doc-validator fixes part 1

* Doc-validator fixes part 2

* More doc-validator fixes

* More doc-validator fixes

* Test

* link test

* Linnk test

* Link test

* More fixes

* More fixes

* Doc-validator fixes

* Doc-validator fixes

* fix broken link

* Fix

* Testing

* Doc fixes

* Link fixes

* Fix links

* Update docs/sources/developers/plugins/create-a-grafana-plugin/_index.md

Co-authored-by: David Harris <david.harris@grafana.com>

* Testing

* Testing

* Testing

* Testing

* Doc-validator fixes

* Doc-validator fixes

* Doc-validator fixes

* Fix broken links for plugins reorganization project

* Prettier fixes

* Prettier fixes

* Incorporate reviewer feedback

* Link fixes

* Link fixes

* Link fixes

* Link fix

* Deleted space

* Codeowners fix

* Change grafana.com links to absolute URLs for Hugo

---------

Co-authored-by: David Harris <david.harris@grafana.com>
2023-07-05 13:25:11 -05:00
Eve Meelan cbf4fe9d23
formatting fix for line 72 (#70618) 2023-06-23 09:56:29 -07:00
Isabel 865636993f
docs: add datasource selector content (#69280)
* updated create dashboard topic including adding screenshot of DS selector

* finished editing build dashboards - create dashboards

* finished data source selection edits'
:

* updated tutorials

* reverted tutorial to old nav to match reality and added that prom DS is preselected

* wording edits

* Apply suggestions from code review

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

* add that configure DS is only for admins

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-06-05 14:45:36 -04:00
Matt Dodson 1c4bb9ca00
[feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

* Update docs/sources/datasources/mysql/_index.md

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition
2023-05-22 15:45:28 -05:00
Torkel Ödegaard 5457a9ecf2
Docs: Update run behind proxy docs (#68608) 2023-05-17 12:18:24 +02:00
Kate Brenner 17b8d28cae
Update build a datasource plugin tutorial (#66381)
* update tutorial

* add punctuation
2023-04-25 12:20:14 -06:00
Kate Brenner 96a191e643
Add link to building backend datasource (#63535)
* add link to building backend datasource

* Update docs/sources/tutorials/build-a-data-source-plugin/index.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Add punctuation.

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
2023-04-25 12:19:19 -06:00
matt abrams cd205e3f46
Update index.md (#64783)
fix typo
2023-04-24 12:38:00 -10:00
Isabel ab53772416
docs: updates for empty dashboard state (#65573)
* empty dashboard related updates

* updated steps to clearly indicate button names

Some steps indicated the heading as the thing to click rather than the button text. Also some of the button text wasn't quite accurate.

* remove incorrect instruction

* apply suggestion from review

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

* pushing empty commit to trigger linting

* triggering linting

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-04-03 10:33:55 -05:00
Ryan McKinley d710507bc5
Chore: Avoid explicit `React.FC<Props>` when possible (#64722) 2023-03-14 16:38:21 +02:00
Timur Olzhabayev f9b9041ad8
Docs: Minor wording changes for plugin signing docs (#64615)
Minor wording changes
2023-03-10 17:33:28 +01:00
Gilles De Mey 6827f97b78
Docs: update the current documentation on notification policies (#64316)
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-03-08 17:18:17 +01:00
Timur Olzhabayev 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
Andres Martinez Gotor 5ce884e92a
Docs: Fix typos for 'Build a data source' tutorial (#63448) 2023-02-21 09:26:14 +01:00
Andres Martinez Gotor 0ab9ac5750
Docs: Reference auth docs in backend-plugin tutorial (#63451) 2023-02-20 15:42:43 +01:00
Will Browne e7bfc4e749
TestData: Remove references to TestData "DB" (#62603)
* remove refs testdatadb

* fix trailing semi-colon

* remove pluginName completely
2023-01-31 16:40:00 +00:00
Jack Baldry 4563111180
Move Grafana tutorials from grafana/tutorials repository (#62309)
* Add Grafana tutorials originally from tutorials repository

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

* Replace tutorials/step shortcode with ordinary headings

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

* Fix typos reported by codespell

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

* Fix doc-validator linting and run prettier

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

* Specify version in tutorials lookup as non-rendered pages do not have a relative permalink used to infer the version

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

* Use latest version

Ensures CI passes and only breaks one website build as the backport to
v9.3.x will solve the missing "latest" pages on publishing.

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-27 17:53:50 +00:00
Jack Baldry a54d18c1f5
Revert "Add Grafana tutorials originally from tutorials repository" (#62283)
Revert "Add Grafana tutorials originally from tutorials repository (#62124)"

This reverts commit f98ad926ac.
2023-01-27 09:25:57 +00:00
Jack Baldry f98ad926ac
Add Grafana tutorials originally from tutorials repository (#62124)
* Add Grafana tutorials originally from tutorials repository

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

* Replace tutorials/step shortcode with ordinary headings

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

* Fix typos reported by codespell

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

* Fix doc-validator linting and run prettier

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-27 09:14:24 +00:00
Diana Payton 715f0133ee
Docs: Remove reference folder (#27944)
* Delete stack_guide_graphite.md

* moved json-model

* Moved Export and import

* Delete _index.md

* Moved Scripted dashboards

* Moved Share dashboard

* fixed links
2020-10-01 14:13:39 -07:00
Diana Payton 552e4cb84d
Docs: Remove feature folder (#27830)
* moved files out of tutorials folder

* link update

* updated weights

* moved Explore

* move files and fix links

* moved files out of features

* Revert "moved files out of features"

This reverts commit 5e44cbcc95.

* fixed links
2020-09-25 13:53:13 -07:00
Amal 9c624b82c4
Minor Grammatical correction (#27742)
* Minor Grammatical correction

* Correcting, as per PR suggestion
2020-09-23 16:19:58 -04:00
Pratik Raj cfc618ef44
Use git clone --depth (#26976)
Signed-off-by: Pratik Raj <rajpratik71@gmail.com>
2020-09-08 09:27:10 +02:00
Diana Payton 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
Amal e63b548c5d
Docs: Minor grammatical correction (#25224) 2020-06-08 11:42:21 -07:00
Ron Klein 57273a8d0c
typo (#25050)
ENABLE_UPD_LISTENER ==> ENABLE_UDP_LISTENER
2020-05-24 18:18:03 +02:00
Amal 820eb5c80e
Docs: Correcting abbreviations (#24748)
* Correction in abbreviation

* Minor correction in abbreviation

* Correcting abbreviation

* Correction in abbreviation

* Correcting abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Update stack_guide_graphite.md

* Update whats-new-in-v4-6.md

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Update ldap.md

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Update docs/sources/guides/whats-new-in-v5.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-18 13:56:23 -07:00
Amal 3c36c0f043
Docs: Grammatical correction in documentation (#23752) 2020-04-21 12:57:39 -07:00
Amal ca20b386bb
docs/sources/tutorials/ha_setup.md: Fix typo 2020-04-21 20:01:14 +02:00
Marcus Olsson f48d444a14
Remove guides (#23589) 2020-04-15 15:19:12 +02:00
Mohit Nain 277edca3a0
Fix typos in ha_setup.md (#22951) 2020-03-23 14:47:41 +01:00
Jeet Parekh f1989f1bfc
docs: change URL occurences to uppercase (#22151)
* change URL occurences to uppercase

* Update docs/sources/tutorials/iis.md

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-14 08:11:08 -08:00
Emil Hessman f0764ceda8 Docs: Use https scheme for Grafana playground links (#21360) 2020-01-06 08:25:13 -08:00
Maisy Kim e031cbb1a1 Docs: fix typo (#21190) 2019-12-23 14:21:38 -08:00
Robby Milo cbd81ffeb8 Docs: update content to work with website repo (#20693)
Updates the docs to work with the website repo - mainly 
relative link updates.
Adds a menu.yaml file to build the sidebar menu (no longer 
using front matter weight).
2019-12-05 13:09:57 +01:00
Diana Payton 5cd4ffffe3
Remove screencasts.md (#20845)
Deleted file and removed link
2019-12-03 13:24:08 -08:00
Brenda Harjala 5b1ac78004 Docs: Simplify headings and make active (#20163)
* Docs: Add additional capitalization rules

What this PR does / why we need it:

This updates the Documentation style guide to include more details on the capitalization rules. Capitalization rules get confused easily, especially between terms like Dashboards (menu title) and dashboards (plural).

Which issue(s) this PR fixes:

No fix, just an addition.

* Revert "Docs: Add additional capitalization rules"

This reverts commit 75cbc6303c.

* Docs: Docs: Add additional capitalization rules

* Docs: Simplify headings and make active #19268
2019-11-05 01:23:00 -08:00