Commit Graph

184 Commits

Author SHA1 Message Date
Sarah Zinger
f32d200fc0
E2E: Add support for data-test-id over aria labels and add importDashboard flow (#36483)
* E2E: Add support for data-testids and not just aria-labels.
2021-07-19 14:01:31 -04:00
Torkel Ödegaard
d4a990215f
Theme: Update theme style guide and docs with new theme info and variable picking guide (#36530)
* Theme: Update theme style guide and docs with new theme info and variable picking guide

* Minor spell fix
2021-07-10 10:24:14 +02:00
Uchechukwu Obasi
f45d0a0b7a
Docs: added an accessibility section in the pull request guide (#36454)
* Docs: added an accessibility section in the pull request guide

* added more points to the accessibility guideline

* fixes some grammar nits

* changed aria to capital case since its an acronym

* added a reference to the Grafana theme

* improved the wordings for better context
2021-07-08 12:04:56 +02:00
Marcus Efraimsson
b26b922658
Contribute: Ongoing refactoring of context.Context everywhere (#36363) 2021-07-02 17:07:21 +02:00
Giordano Ricci
13cf6a3e00
Docs: Add Volta to Grafana dev setup instructions (#35064)
* Chore: update developer guide to use Volta

* Chore: Fix Volta config

* Chore: Add volta config to each workspace

* Chore: Add volta config to each workspace

* Apply suggestions from code review

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

* Update contribute/developer-guide.md

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-06-02 09:08:38 +01:00
Maria Alexandra
35061fc66d
Docs: Improve the create pull request guide for contributing (#34799)
- add extra section about frontend unit test

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>
Co-authored-by: Hugo Häggmark <hugo.haggmark@grafana.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-05-28 10:01:25 +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
Gang Chen
7509c6cbc4
Documentation: Update developer-guide.md (#33478) 2021-04-28 11:35:32 -04:00
Jack Westbrook
c809d63065
Buttons: replace usage of .btn classnames (#33226)
* refactor(loginpage): migrate custom button styles to use Button component

* refactor(certificationkey): prefer grafana-ui form elements over html elements and classnames

* refactor(axisselector): prefer grafana-ui Button component over html button element

* refactor(input-datasource): replace use of btn class with grafana-ui components

* chore(grafana-ui): delete deprecated ToggleButtonGroup component

* refactor: replace btn and cta-form__close class usage with IconButton

* chore(closebutton): post master merge use v2 theme

* refactor(permissionlist): remove usage of .btn classname

* Wip

* docs(styling): update styling and theme docs import paths

* refactor(alerting): remote btn classnames from TestRuleResult

* refactor(apikeys): prefer grafana-ui Button components over btn classNames

* refactor(folders): prefer grafana-ui Button components over btn classNames

* refactor(teams): prefer grafana-ui Button components over btn classNames

* refactor(datasources): prefer grafana-ui Button components over btn classNames

* refactor: prefer grafana-ui Button components over btn classNames

* Minor style tweak to service buttons

* test: update snapshots related to button changes

* chore(input-datasource): remove unused import declaration

* refactor(loginservicebuttons): rename theme.palette to theme.colors

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2021-04-23 10:06:42 +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
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
Arve Knudsen
d88864f376
Fix language in backend.md (#26701)
* Fix language in backend.md

* Update contribute/style-guides/backend.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-07-30 17:48:41 +02:00
Emil Tullstedt
ec76d69b49
Chore: Update developer guide to reflect changes to go get (#26646) 2020-07-29 11:23:46 +02:00
Diana Payton
9b17fe436c
Update documentation-style-guide.md (#26534) 2020-07-22 14:52:16 -07:00
Josh Soref
7d08a8497a
Chore: fix spelling of GitHub (#26182)
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-07-22 08:12:50 -07:00
Josh Soref
7752434d11
Docs: Use current spelling for macOS (#26181) 2020-07-09 08:06:04 -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
Eivind Gussiås Løkseth
338ce0cc10
Docs: Default configuration is defaults.ini (#26071)
Fixes #26068 
The `conf ` directory doesn't have any `grafana.ini`, but a `defaults.ini`, which contains the default configuration.
2020-07-06 11:00:03 +02:00
Alexander Tymchuk
dda231009f
docs: remove a section on PhantomJS debugging in e2e.md (#25951) 2020-07-01 17:28:06 +02:00
Tobias Skarhed
bd27be1351
Docs: Update styling docs for useStyles (#25944) 2020-07-01 11:39:46 +02:00
Josh Soref
686149966a
docs: spelling (#24383)
* Docs: spelling

* Docs: spelling (contribute/ directory)

* Drop whats-new-in changes
2020-06-30 14:42:50 -07:00
Hugo Häggmark
e55756066b
Docs: updates frontend style guides (#25391)
* Update frontend.md

* Update contribute/style-guides/frontend.md

Co-authored-by: Marcus Olsson <accounts+github@marcus.se.net>

Co-authored-by: Marcus Olsson <accounts+github@marcus.se.net>
2020-06-05 13:54:27 +02:00
Josh Soref
91a83b71c3
Docs: Fix table of contents link (#24339) 2020-05-06 12:50:55 -07:00
Andrej Ocenas
d3b19adbed
Docs: Update style guide with explicit return types (#23918) 2020-05-05 17:36:28 +02: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
Marcus Efraimsson
94efd06858
End2end: Make it possible to run e2e tests with BASE_URL (#24041) 2020-05-03 13:51:30 +02:00
Hugo Häggmark
b09b49fb37
e2e: creates a separate package for selectors (#23858)
* Initial commit

* Chore: fixes after merge

* Chore: removes todos

* Chore: uncomment test

* Chore: adds missing externals to rollup config

* Refactor: selectors is master for everything

* Docs: updates Docs

* Chore: adds e2e-selectors to publish
2020-04-27 09:09:05 +02:00
Amal
fd6502b32f
Minor grammatical correction (#23898) 2020-04-26 10:53:37 +02:00
Diana Payton
e05f686758
Docs: Update documentation-style-guide.md (#23659)
Added Divio link
2020-04-19 07:17:19 +02:00
Diana Payton
a343b62a23
Docs: Update README.md (#23660) 2020-04-19 07:16:57 +02:00
Cyril Tovena
24b928c88d
Docs: Update contributing doc to install node@12. (#23450) 2020-04-08 20:29:10 -07:00
Tobias Skarhed
6748ceae67
Update storybook.md (#23374) 2020-04-07 06:59:50 +02:00
Tobias Skarhed
b86789c66b
Docs: task template typo (#23322) 2020-04-03 17:19:01 +02:00
Andrej Ocenas
e799d0fdec
Docs: Add note about ulimit in bash_profile (#22562)
* Add note about ulimit in bash_profile

* developer-guide.md: Document retaining ulimit changes

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

* Fix language

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

* developer-guide.md: Describe troubleshooting ulimit issues

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

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-03-31 10:00:55 +02:00
Tobias Skarhed
6d6d86f940
Storybook: Add internal stories functionality (#23139) 2020-03-27 14:37:08 +01: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
Torkel Ödegaard
75d7f9072c
E2E: Add new run modes for e2e tests (#22795)
* WIP: started e2e tests for bar gauge

* Updated

* Updated

* Updated cypress from 3.7 -> 4.1

* reverted cypress upgrade

* Updated test

* Update e2e docs

* Updated docs
2020-03-16 14:35:55 +01:00
Daniel Mietchen
1228fdc57a
copyedits (#20817)
Co-authored-by: bergquist <carl.bergquist@gmail.com>
2020-03-13 07:30:04 +01: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
Carl Bergquist
0b86a371bb
remove section about alias imports (#22585)
this is not relevant anymore since we removed
all aliased imports.
2020-03-05 19:51:14 +01:00
Joseph Robinson
b24c7cdd64
Docs: Added a Markdown Style Guide (#22425)
* Docs: Adding a Markdown Style Guide

What this PR does / why we need it: This request builds a markdown style guide for writers documenting information about Grafana services for users.
This PR serves the need to make documentation and READMEs more consistent and maintainable.

Which issue(s) this PR fixes: This request fixes the issue grafana#19592

Fixes grafana#19592

Special notes for your reviewer:

@marcusolsson and @oddlittlebird, sorry for the delay. I've set up the style guide, and it is ready for review, or additional sections.

* Docs: Adding a Markdown Style Guide

What this PR does / why we need it: This request builds a markdown style guide for writers documenting information about Grafana services for users.
This PR serves the need to make documentation and READMEs more consistent and maintainable.

Which issue(s) this PR fixes: This request fixes the issue grafana#19592

Fixes grafana#19592

Special notes for your reviewer:

@marcusolsson and @oddlittlebird, sorry for the delay. I've set up the style guide, and it is ready for review, or additional sections.

* Docs: fixing typos and char repetition

Editing some typos in the text, and removing the repetition of A and B characters that appeared in the file.

* Docs: Changing content following review of new Markdown Style Guide

- adjustment to headings to sentence case.
- adding an introduction
- removing punctuation content
- making suggested word and punctuation fixes

Fixes #19592
2020-03-03 09:06:00 -08:00
Tobias Skarhed
2483efb8c5
Docs: Add Storybook guidelines (#22465)
* Add Storybook guidlines

* Make lists

* Update contribute/style-guides/storybook.md

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

* Update contribute/style-guides/storybook.md

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

* Update contribute/style-guides/storybook.md

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

* Update contribute/style-guides/storybook.md

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

* Update contribute/style-guides/storybook.md

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

* Update contribute/style-guides/storybook.md

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

* Update contribute/style-guides/storybook.md

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

* Apply suggestions from code review

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

* Update docs with feedback

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-03-02 20:11:04 +01:00
Marcus Andersson
e2038e0614
Docs: adding API reference documentation support for the packages libraries. (#21931)
* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added parameters and return values.

* Fixed merge error.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* lerna bootstrap.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.
2020-02-25 13:59:11 +01:00
Rob McGuire
c758440c50
Docs: Fix examples, grammar, add links (#22406)
- Fix examples: syntax errors, formatting
- Add links to referenced Emotion documentation
- Fix grammar, punctuation
- Update headings: Remove top-level "Emotion", adjust others
2020-02-24 17:54:28 -08:00
Rob McGuire
798d62c605
Docs: Add links, fix grammar, formatting, wording (#22381)
* Docs: Add links, fix grammar, formatting, wording

- Add links to theme files and technology references
- Adjust formatting to be consistent, e.g., syntax highlighting, section spacing
- Fix misc grammar, punctuation
- Fix SASS -> Sass

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-24 23:05:56 +01:00
Dominik Prokop
d6ca781c49
Docs: Update front-end style guide (#22197)
* Update front end style guide

* Update contribute/style-guides/frontend.md

* Update contribute/style-guides/frontend.md

* Add code samples after review

* Update contribute/style-guides/frontend.md

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Update contribute/style-guides/frontend.md

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

* Review

* Review

* Update contribute/style-guides/frontend.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-21 07:35:54 +01:00
Diana Payton
6ee84cd2fc
Docs: Add doc templates (#21927)
* Adding template docs

* Update doc-concept-template.md

* Added content to templates

* Added task info
2020-02-11 14:05:39 -08:00
Diana Payton
4a8dfc42cf
Update documentation-style-guide.md (#21736)
Added "metadata" to Word Usage
2020-02-06 08:33:55 -08:00
Émile Fugulin
be09722d84 Fix typos in the communication documentation (#21774) 2020-01-28 09:26:59 +01:00
Hugo Häggmark
5dddc91ba5
Chore: Fixes PhantomJs by adding polyfills for fetch and AbortController (#21655)
* Chore: Fixes PhantomJs rendering

* Docs: Updated docs

* Update contribute/style-guides/e2e.md

Co-Authored-By: Dominik Prokop <dominik.prokop@grafana.com>

* Docs: Updates docs according to PR comments

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
2020-01-22 08:15:31 +01:00