IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-30 12:44:10 -06:00
Code Issues Packages Projects Releases Wiki Activity
26,229 Commits 5,113 Branches 538 Tags 1.9 GiB
15c72c2739
Commit Graph

50 Commits

Author SHA1 Message Date
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
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
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
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
Diana Payton
e05f686758
Docs: Update documentation-style-guide.md (#23659) 
Added Divio link
 2020-04-19 07:17:19 +02:00
Tobias Skarhed
6748ceae67
Update storybook.md (#23374) 2020-04-07 06:59:50 +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
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
4a8dfc42cf
Update documentation-style-guide.md (#21736) 
Added "metadata" to Word Usage
 2020-02-06 08:33:55 -08: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
Dominik Prokop
aba402f98e
E2E docs: Add guide to debuging PhantomJS (#21606) 
* Add guide to debuging PhanomJS

* Update contribute/style-guides/e2e.md
 2020-01-20 08:34:36 +01:00
Hugo Häggmark
4f0fa776be
Chore: Migrates reducers and actions to Redux Toolkit (#21287) 
* Refactor: Adds Redux Toolkit package

* Refactor: Uses configureStore from Redux Toolkit

* Refactor: Migrates applicationReducer

* Refactor: Migrates appNotificationsReducer

* Refactor: Migrates locationReducer

* Refactor: Migrates navModelReducer

* Refactor: Migrates teamsReducer and teamReducer

* Refactor: Migrates cleanUpAction

* Refactor: Migrates alertRulesReducer

* Refactor: Cleans up recursiveCleanState

* Refactor: Switched to Angular compatible reducers

* Refactor: Migrates folderReducer

* Refactor: Migrates dashboardReducer

* Migrates panelEditorReducer

* Refactor: Migrates dataSourcesReducer

* Refactor: Migrates usersReducer

* Refactor: Migrates organizationReducer

* Refactor: Migrates pluginsReducer

* Refactor: Migrates ldapReducer and ldapUserReducer

* Refactor: Migrates apiKeysReducer

* Refactor: Migrates exploreReducer and itemReducer

* Refactor: Removes actionCreatorFactory and reducerFactory

* Refactor: Moves mocks to test section

* Docs: Removes sections about home grown framework

* Update contribute/style-guides/redux.md

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

* Refactor: Cleans up some code

* Refactor: Adds state typings

* Refactor: Cleans up typings

* Refactor: Adds comment about ImmerJs autoFreeze

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
 2020-01-13 08:03:22 +01: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
Hugo Häggmark
34aaa3d1f7
Docs: Adds best practices after visit and a link back to e2e.md (#21117) 
* Docs: Adds best practices after visit and a link back to e2e.md in grafana-e2e

* Update contribute/style-guides/e2e.md

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

* Update packages/grafana-e2e/README.md

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

* Docs: Changes after PR comments

* Update contribute/style-guides/e2e.md

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

* Update contribute/style-guides/e2e.md

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

* Docs: Changes after PR comments
 2019-12-18 16:09:27 +01:00
Hugo Häggmark
1774b8f7e9
Docs: Updates from puppeteer to Cypress (#20962) 
* Docs: Updates from puppeteer to Cypress

* e2e: Adds documentation

* Docs: Adds link to e2e framework from contributing

* Docs: Updates after PR comments

* Update contribute/style-guides/e2e.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update contribute/style-guides/e2e.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update contribute/style-guides/e2e.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update contribute/style-guides/e2e.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update contribute/style-guides/e2e.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update contribute/style-guides/e2e.md

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

* Update contribute/style-guides/e2e.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update contribute/style-guides/e2e.md

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

* Docs: Breaks a long sentance in two
 2019-12-10 09:49:12 +01: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
Dominik Prokop
bff08ab99f
Enable theme context mocking in tests (#20519) 
* Enable theme context mocking in tests

* Expose mockThemeContext from grafana/ui

* Add docs

* Update contribute/style-guides/themes.md

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

* Update packages/grafana-ui/src/themes/ThemeContext.tsx

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

* Update contribute/style-guides/themes.md

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

* Docs update

* Update contribute/style-guides/themes.md

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>
 2019-11-21 16:52:57 +01:00
Hugo Häggmark
e60f7d008e
Docs: Updates docs for redux framework (#20377) 
* Docs: Updates docs for redux framework

* Update contribute/style-guides/redux.md

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

* Update contribute/style-guides/redux.md

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

* Update contribute/style-guides/redux.md

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

* Update contribute/style-guides/redux.md

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

* Docs: Updates after PR comments

* Update redux.md
 2019-11-15 07:30:50 +01:00
Marcus Olsson
69906f73a2
Docs: Consolidate backend guidelines (#19823) 
* Consolidate backend guidelines

* Fix link

* Fix review comments
 2019-10-30 13:59:27 -07:00
Marcus Olsson
73944c18fd
Docs: Clean up contribute docs (#19716) 2019-10-22 16:23:46 +02: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
Dominik Prokop
6f7f9aa774 Add missing info about stylesFactory 2019-10-14 12:29:10 +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