Commit Graph

123 Commits

Author SHA1 Message Date
Diana Payton
7896c6a7b1
Update documentation-style-guide.md (#32690) 2021-04-05 16:58:38 +02:00
Arve Knudsen
10bb3561f5
Docs: Document upgrading of protobuf (#32227)
* Docs: Document upgrading of protobuf

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

* Document protobuf re-compiling

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

* Update CODEOWNERS

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-03-22 19:28:33 +01:00
Uchechukwu Obasi
61521216ed
Docs: updates developer guide with useful resources for windows setup (#32075)
* Docs: updates developer guide with useful resources for windows setup

* fixes small grammar nits
2021-03-18 09:39:54 -04:00
Will Browne
8e1c2d6472
move backend docs to their relevant folder (#32041) 2021-03-17 09:41:16 +01:00
Arve Knudsen
6081c00119
Docs: Document backend package hierarchy model (#31930)
* Docs: Document backend package hierarchy model

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-03-16 10:49:01 +01:00
Uchechukwu Obasi
4dc5ac858e
Docs: updated developer guide (#29978)
* Docs: updated developer guide

* Fix: made heading uppercase

* small nit fix
2021-02-05 09:35:21 +01:00
achatterjee-grafana
1a37ba24d3
Added entry for web server. (#30715) 2021-01-28 11:37:14 -05:00
Arve Knudsen
19c639109c
Docs: Define TLS/SSL terminology (#30533)
* Docs: Define TLS/SSL terminology

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

* Apply suggestions from code review

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

* Change title

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

* Move terminology.md

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

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-01-26 17:55:55 +01: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
Dominik Prokop
951b11a9a5
Update styling.md guide (#30594) 2021-01-25 12:52:22 +01: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
Arve Knudsen
b94fec8011
contribute: Add backend and configuration guidelines for PRs (#30426)
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-01-20 12:27:48 +01:00
Arve Knudsen
4e37941cc4
Backend style guide: Document JSON guidelines (#30267)
* Backend style guide: Document JSON guidelines

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-01-14 07:49:25 +01:00
Diana Payton
5483fbff7d
Update documentation-markdown-guide.md (#30207) 2021-01-12 13:41:19 -08:00
Diana Payton
d6948bae62
Update documentation-markdown-guide.md (#30235) 2021-01-12 12:25:05 -08:00
Arve Knudsen
21e835f3a6
Backend style guide: Document database patterns (#30219)
* Backend style guide: Document database patterns

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

* Wording

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

* Avoid stacked headings

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-01-12 16:24:22 +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
Arve Knudsen
0c8498401e
Backend style guide: Add more guidelines (#29871)
* backend style guide: Add more guidelines

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

* Apply suggestions from code review

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
2020-12-16 19:35:07 +01:00
Raymond
f4fcd875c1
Fix the broken link of XORM documentation (#29865) 2020-12-16 10:39:02 +01:00
Alex Khomenko
dd1cbd21f0
Docs: Add info about typing of connected props to Redux style guide (#29842)
* Add info about typing of connected props

* Update with suggestions
2020-12-15 16:27:43 +02: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
Arve Knudsen
12123f0540
Style guide: Document avoidance of globals in Go code (#29803)
* Chore: Document avoidance of globals in Go code

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-12-14 09:38:52 +01: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
Diana Payton
5a780227b0
Update documentation-markdown-guide.md (#29659)
* Update documentation-markdown-guide.md

* Update documentation-markdown-guide.md

* Update documentation-markdown-guide.md

* Update documentation-markdown-guide.md
2020-12-07 10:50:44 -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
Kyle Brandt
22ee0a912c
Chore: Update dev guide node version for Mac (#29548) 2020-12-02 12:08:45 -08:00
Diana Payton
778476906b
Update documentation-style-guide.md (#29354) 2020-11-24 12:41:39 -08:00
Jack Westbrook
0fc8426bf1
Chore: Bump storybook to v6 (#28926)
* Wip

* feat: get storybook and app building locally

* docs: comment webpack react alias

* build(grafana-ui): put back ts-loader

* build: prefer storybook essentials over actions and docs. bump dark-mode

* chore(storybook): migrate to latest config

* build: prevent test env throwing Invalid hook call errors

* chore: lodash resolves to package dependency rather than project

* use decorators as variable instead of function

* perf(storybook): reduce bundling time by splitting type check and compilation

* refactor(storybook): use sortOrder.order param to sort intro story first

* build: use yarn workspace command

* refactor(storybook): use previous knobs addon registration

* migrate button story to controls

* build(storybook): silence warnings in console

* build: bump storybook related ts packages

* style: remove trailing whitespace

* refactor(graphng): export interface for storybook

* controls migration guide

* fix typo

* docs(storybook): default docs to use dark theme as per current implementation

* revert(grafana-ui): put back react-is namedExport

this was changed for react 17 bump but causes rollup to fail during bundling

* chore: bump storybook to 6.1, enable fastRefresh, silence eslint prop-types

* docs(grafana-ui): move knobs -> controls migration guide to storybook style-guide

* chore(storybook): silence terminal warning about order of docs addon

* Update contribute/style-guides/storybook.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Apply documentation suggestions

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* chore(storybook): bump to 6.1.2

Co-authored-by: Peter Holmberg <peter.hlmbrg@gmail.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2020-11-24 10:38:41 +01: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
Arve Knudsen
b5379c5335
Chore: Fix SQL related Go variable naming (#28887)
* Chore: Fix variable naming

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-11-11 06:21:08 +01:00
Zoltán Bedi
f22d77100f
Chore: use jest without grunt (#28558)
* Chore: use jest without grunt

* Run no-focus-convey-tests and no-only-tests as well

* Update lib.star test-backend script with no-focus test to run first

* Lets see a failing test

* Revert "Lets see a failing test"

This reverts commit cb6c6ed67d.

* Update no-focus-convey test to a script

* Update scripts/lib.star

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update drone.yml

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-11-09 15:14:04 +01: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
Arve Knudsen
4ec60c7187
Developer guide: Update wrt. Windows (#28559)
* Developer guide: Update wrt. Windows

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

* Update contribute/developer-guide.md

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

* Update contribute/developer-guide.md

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>
2020-10-29 08:04:37 +01: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
Hugo Häggmark
b497063f64
Docs: Adds basic frontend data request concepts (#28253)
* Docs: Adds frontend data request docs

* Update contribute/architecture/frontend-data-requests.md

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

* Update contribute/architecture/frontend-data-requests.md

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

* Update contribute/architecture/frontend-data-requests.md

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

* Update contribute/architecture/frontend-data-requests.md

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

* Docs: changes after PR comments

* Docs: changes after PR comments

* Docs: changes after PR comments

* Update contribute/architecture/frontend-data-requests.md

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>
Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
Co-authored-by: achatterjee-grafana <34888589+ashishagarwal06@users.noreply.github.com>
2020-10-20 10:22:29 +02: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
DECarreras
54df058b95
Docs: Fixed lazy numbering in all documentation files (#27975) 2020-10-01 12:45:05 -04:00
denominator
1d2b839a1d
Docs: Fix note format for documentation (#27940) 2020-09-30 12:45:07 -07:00
Diana Payton
0138bbee3d
Update documentation-markdown-guide.md (#27817) 2020-09-25 10:16:11 -07:00
Joan López de la Franca Beltran
3fb4a51404
Update Contribute/Architecture/Services documentation (#27722) 2020-09-23 12:34:00 +02: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
Steven Vachon
2e3b6b6850
Docs: E2E (#27461)
* Separated generalized E2E docs from that of core

… and rewrote some minor things to be more concise for faster reads.

* Added plugins E2E document
2020-09-09 08:55:42 -04:00
Diana Payton
5cc65df32b
Update documentation-style-guide.md (#26706) 2020-07-30 11:31:49 -07:00