Commit Graph

46 Commits

Author SHA1 Message Date
Arve Knudsen
78596a6756 Migrate to Wire for dependency injection (#32289)
Fixes #30144

Co-authored-by: dsotirakis <sotirakis.dim@gmail.com>
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: Ida Furjesova <ida.furjesova@grafana.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
Co-authored-by: Andrej Ocenas <mr.ocenas@gmail.com>
Co-authored-by: spinillos <selenepinillos@gmail.com>
Co-authored-by: Karl Persson <kalle.persson@grafana.com>
Co-authored-by: Leonard Gram <leo@xlson.com>
2021-08-25 15:11:22 +02:00
Ursula Kallio
a058a09b9b Include voice and tone summary (#37742)
Fix https://github.com/grafana/technical-documentation/issues/35.
2021-08-11 11:30:40 +02:00
Arve Knudsen
c2c1ec7d0f Chore: Move from master to main branch (#33693)
* Chore: Move from master branch to main

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* CI: Upgrade build pipeline tool to v2

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-05-06 16:29:29 +02:00
Diana Payton
50ab6155ff Update documentation-style-guide.md (#32959) 2021-04-13 21:40:28 +02:00
Harold Dost
9efaa2c13f Fix style guide: web server (#32817) 2021-04-09 01:02:00 +02:00
Diana Payton
7896c6a7b1 Update documentation-style-guide.md (#32690) 2021-04-05 16:58:38 +02:00
achatterjee-grafana
1a37ba24d3 Added entry for web server. (#30715) 2021-01-28 11:37:14 -05:00
Diana Payton
c1906db21f Update documentation-style-guide.md (#30611)
* Update documentation-style-guide.md

* Update contribute/style-guides/documentation-style-guide.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-01-26 07:46:27 -08:00
Ursula Kallio
f97348ff5b List + before -; rm old Git ref; reformat. (#30543)
* List + before -; rm old Git ref; reformat.

* Update contribute/style-guides/documentation-style-guide.md

* Update contribute/style-guides/documentation-style-guide.md

* Update contribute/style-guides/documentation-style-guide.md

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

* Update contribute/style-guides/documentation-style-guide.md

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

* Update contribute/style-guides/documentation-style-guide.md

* Update contribute/style-guides/documentation-style-guide.md

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

* Update contribute/style-guides/documentation-style-guide.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-01-22 18:30:24 +01:00
Diana Payton
ad5762cd6a Update documentation-style-guide.md (#30202) 2021-01-11 11:28:04 -08:00
achatterjee-grafana
0561c941af Minor correction to explanation on correct MS SQL usage. (#29889)
* Minor correction to explanation added for correct MS SQL usage.

* Update contribute/style-guides/documentation-style-guide.md

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-12-17 09:45:04 -05:00
achatterjee-grafana
5d4910dd52 Update style guide with correct usage of MS SQL (#29829)
* Added correct usage of MS SQL

* Updated as per Diana's comment.

* Fixed wording.

* Update contribute/style-guides/documentation-style-guide.md

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-12-14 16:36:03 -05:00
Diana Payton
785aa4df26 Update documentation-style-guide.md (#29661)
* Update documentation-style-guide.md

* Update documentation-style-guide.md

* Update documentation-style-guide.md
2020-12-07 10:51:11 -08:00
Marcus Olsson
45c6daaf95 Add changelog to docs style guide (#29581)
* Add changelog to docs style guide

* Fix review comments
2020-12-07 10:35:24 +01:00
Diana Payton
4bf8a828d1 Update documentation-style-guide.md (#29586) 2020-12-03 10:42:12 -08:00
Diana Payton
b63e6959df Update documentation-style-guide.md (#29580) 2020-12-03 08:12:46 -08:00
Diana Payton
778476906b Update documentation-style-guide.md (#29354) 2020-11-24 12:41:39 -08:00
Diana Payton
ec864f6461 Doc: Update documentation-style-guide.md (#29082)
* Update documentation-style-guide.md

* Update documentation-style-guide.md
2020-11-13 07:33:33 -08:00
Diana Payton
d2ac7dc007 Update documentation-style-guide.md (#28908) 2020-11-06 12:39:12 -08:00
Matthew Helmke
50239f11e5 Adding terms to glossary (#28884)
* Adding terms to glossary

* requested edits and addition to style guide

* Update contribute/style-guides/documentation-style-guide.md

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

* Update docs/sources/getting-started/glossary.md

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>

* Update docs/sources/getting-started/glossary.md

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>
2020-11-06 16:33:32 +01:00
achatterjee-grafana
cb1449e4fe Reoeragnization. (#28760) 2020-11-02 14:11:27 -05:00
achatterjee-grafana
b6bb069e08 Updated documentation style guide (#28488)
* Added node_exporter to the list of words to use in Grafana documentation style guide

* Update contribute/style-guides/documentation-style-guide.md

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-23 11:35:12 -04:00
Matthew Helmke
16b8f60e38 Update documentation-style-guide.md (#28038)
Just a typo fix.
2020-10-05 15:57:49 -04:00
Diana Payton
81ec13b76d Update documentation-style-guide.md (#28037) 2020-10-05 12:03:12 -07:00
John S
4d3067e139 Docs: Refactor inconsistent unordered lists (#27826)
* Docs: Refactor inconsistent unordered lists

* add requested changes

* Update docs/sources/linking/data-link-variables.md

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

* Update docs/sources/http_api/_index.md

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

* Update docs/sources/guides/whats-new-in-v6-0.md

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

* Update docs/sources/auth/auth-proxy.md

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

* resolve weird line breaks

* revert unintentional change

* Update docs/sources/auth/auth-proxy.md

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

* Update docs/sources/auth/auth-proxy.md

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

* Update docs/sources/auth/auth-proxy.md

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 11:02:11 -07:00
Diana Payton
19c5c96d4c Update documentation-style-guide.md (#27581)
* Update documentation-style-guide.md

* Update documentation-style-guide.md
2020-09-14 12:52:59 -07:00
Diana Payton
5cc65df32b Update documentation-style-guide.md (#26706) 2020-07-30 11:31:49 -07:00
Diana Payton
9b17fe436c Update documentation-style-guide.md (#26534) 2020-07-22 14:52:16 -07:00
Marcus Olsson
0f41ca620b Docs: Add guidelines for inclusive language (#25533)
* Docs: Add guidelines for inclusive language

* Fix review comments

* Fix review comments

* Update documentation-style-guide.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-07-06 12:59:34 -07:00
Diana Payton
a8ba503b35 Update documentation-style-guide.md (#24020)
* Update documentation-style-guide.md

Added guidance on jargon

* Update documentation-style-guide.md
2020-05-05 07:50:18 -07:00
Diana Payton
e05f686758 Docs: Update documentation-style-guide.md (#23659)
Added Divio link
2020-04-19 07:17:19 +02:00
Diana Payton
57c55f7e16 Update documentation-style-guide.md (#22733)
Co-authored-by: bergquist <carl.bergquist@gmail.com>
2020-03-24 07:19:02 -07:00
Diana Payton
733450c7b7 Update documentation-style-guide.md (#22581)
Added link to Google tech writing courses
2020-03-06 06:50:23 -08:00
Diana Payton
4a8dfc42cf Update documentation-style-guide.md (#21736)
Added "metadata" to Word Usage
2020-02-06 08:33:55 -08:00
Diana Payton
cfba25630e Docs: Update documentation-style-guide.md (#21322)
* Update documentation-style-guide.md

Added Commands and code section.

* Update documentation-style-guide.md

* Update documentation-style-guide.md

Added code block examples

* Update documentation-style-guide.md
2020-01-10 11:53:05 -08:00
Diana Payton
4a7c514727 Update documentation-style-guide.md (#20871)
Updated "open source" word usage.
2019-12-05 07:24:32 -08:00
Diana Payton
899de7fe27 Update documentation-style-guide.md (#20777)
Updated the word usage in the documentation style guide with checkout and check out.
2019-12-02 09:47:45 -08:00
Daniel Lee
76598cc831 docs: fix merge conflicts 2019-10-22 10:01:51 +02:00
Oddlittlebird
830cd21cd5 Edited Contribute docs
Edited several docs in the contribute folder.
2019-10-16 19:49:47 -07:00
Brenda Harjala
16fa712b59 Docs: Add additional capitalization rules (#19805)
* 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
2019-10-15 11:44:51 +02:00
Manoj
397e30e2bf Docs: Add additional word usage rule (#19812)
Resolves #19810
2019-10-15 11:44:02 +02:00
HG00
a427ff7f8d Docs: Add API style/casing rule (#19627)
* Docs: Update Centrify Section In Generic Oauth Ref #18207

* Docs: Alphabetise Features / Data Sources (#19289)

* Docs: Add Title Case rule for API names (#19620)

* Update contribute/style-guides/documentation-style-guide.md

wfm, thanks!

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>
2019-10-11 13:07:16 +02:00
Robert Lowry
b0bf2ea09f Docs: Add "repository" case, and "open source" to style guide
closes #19404
closes #19281
2019-10-08 23:22:30 +02:00
Manish Yadav
2ac9fad603 Docs: Add correct casing for API and ID to style guide (#19625) 2019-10-08 18:00:41 +02:00
oddlittlebird
42a93d2745 Docs: Add additional style rules (#19634)
* Update documentation-style-guide.md

Added items to the documentation style guide.

* Update contribute/style-guides/documentation-style-guide.md

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* Update documentation-style-guide.md

Removed extra lines
2019-10-07 16:48:32 +02:00
Marcus Olsson
2fb301ccaf Docs: Improve guides for contributing (#19575)
* Move style guides into contribute directory

* Move contribution guides into contribute directory

* Refactor CONTRIBUTING.md

* Clean up docs/README.md

* Update reference to style guide and minor formatting fixes

* Apply suggestions from code review

Co-Authored-By: gotjosh <josue.abreu@gmail.com>

* Update CONTRIBUTING.md

Co-Authored-By: gotjosh <josue.abreu@gmail.com>
2019-10-03 14:13:58 +02:00