9b17fe436c
Update documentation-style-guide.md ( #26534 )
2020-07-22 14:52:16 -07:00
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
7752434d11
Docs: Use current spelling for macOS ( #26181 )
2020-07-09 08:06:04 -07:00
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
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
dda231009f
docs: remove a section on PhantomJS debugging in e2e.md ( #25951 )
2020-07-01 17:28:06 +02:00
bd27be1351
Docs: Update styling docs for useStyles ( #25944 )
2020-07-01 11:39:46 +02:00
686149966a
docs: spelling ( #24383 )
...
* Docs: spelling
* Docs: spelling (contribute/ directory)
* Drop whats-new-in changes
2020-06-30 14:42:50 -07:00
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
91a83b71c3
Docs: Fix table of contents link ( #24339 )
2020-05-06 12:50:55 -07:00
d3b19adbed
Docs: Update style guide with explicit return types ( #23918 )
2020-05-05 17:36:28 +02:00
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
94efd06858
End2end: Make it possible to run e2e tests with BASE_URL ( #24041 )
2020-05-03 13:51:30 +02:00
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
fd6502b32f
Minor grammatical correction ( #23898 )
2020-04-26 10:53:37 +02:00
e05f686758
Docs: Update documentation-style-guide.md ( #23659 )
...
Added Divio link
2020-04-19 07:17:19 +02:00
a343b62a23
Docs: Update README.md ( #23660 )
2020-04-19 07:16:57 +02:00
24b928c88d
Docs: Update contributing doc to install node@12. ( #23450 )
2020-04-08 20:29:10 -07:00
6748ceae67
Update storybook.md ( #23374 )
2020-04-07 06:59:50 +02:00
b86789c66b
Docs: task template typo ( #23322 )
2020-04-03 17:19:01 +02:00
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
6d6d86f940
Storybook: Add internal stories functionality ( #23139 )
2020-03-27 14:37:08 +01:00
57c55f7e16
Update documentation-style-guide.md ( #22733 )
...
Co-authored-by: bergquist <carl.bergquist@gmail.com >
2020-03-24 07:19:02 -07:00
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
1228fdc57a
copyedits ( #20817 )
...
Co-authored-by: bergquist <carl.bergquist@gmail.com >
2020-03-13 07:30:04 +01:00
733450c7b7
Update documentation-style-guide.md ( #22581 )
...
Added link to Google tech writing courses
2020-03-06 06:50:23 -08:00
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
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
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
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
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
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
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
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
4a8dfc42cf
Update documentation-style-guide.md ( #21736 )
...
Added "metadata" to Word Usage
2020-02-06 08:33:55 -08:00
be09722d84
Fix typos in the communication documentation ( #21774 )
2020-01-28 09:26:59 +01:00
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
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
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
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
71411490bf
Docs: Edited Windows install instructions ( #20780 )
...
* Edited Windows install instructions
Moved one section from Windows install guide to developer-guide.md. Edited some content in windows.md and will add questions.
* Updated per comments
* Fixed broken links in basic_concepts.md
* Revert "Fixed broken links in basic_concepts.md"
This reverts commit e524ea9e7b
2019-12-30 07:53:38 -08:00
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
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
58cffde0f2
e2e: Uses Cypress instead of Puppeteer ( #20753 )
...
* WIP: intial commit
* Tests: Runs e2e tests
* Refactor: Adds BASE_URL support
* Refactor: Adds namespacing
* Refactor: Cleans up the Page api
* Build: Adds to build-branches-and-prs job for testing
* Build: Hardcoded image for now
* Refactor: Uses Selectors in App
* Refactor: Adds addDataSource flow
* WIP
* Refactor: Adds e2eScenario
* Refactor: Adds add and delete scenarios
* Refactor: Adds logging
* Refactor: Adds ability to for Selectors with variables
* Refactor: Using variable selectors instead
* Refactor: Adds flow until Share Panel
* Refactor: Adds clicking on rendered image link
* Refactor: Deletes log output
* Refactor: Updates snapshots
* Chore: Reverts changes
* Refactor: Removes log plugin because maybe it breaks yarn build
* Refactor: Adds rendered image download
* Refactor: Adds image comparison
* Refactor: Removes uncaught errors override
* Refactor: Changes order of images to compare
* Refactor: Updates truth image
* Build: Updates path to CI artifacts
* Refactor: Cleaning up types and config
* wip
* Refactor: Cleans up external api
* Refactor: More cleanup
* Refactor: More cleanup
* Refactor: Removes usages of Pages and Flows
* Refactor: Removes last traces of Cypress in spec
* Refactor: Adds comments
2019-12-09 00:14:25 -08:00
4a7c514727
Update documentation-style-guide.md ( #20871 )
...
Updated "open source" word usage.
2019-12-05 07:24:32 -08:00
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
662e514f1d
Update services.md ( #20604 )
...
Fixed a typo.
2019-11-23 13:03:59 +01:00
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
4f4898a782
Document required Go version in developer guide ( #20546 )
...
* Docs: Document required Go version in developer guide
2019-11-21 12:05:29 +01:00
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
Diana Payton
Josh Soref
Marcus Olsson
Eivind Gussiås Løkseth
Alexander Tymchuk
Tobias Skarhed
Hugo Häggmark
Andrej Ocenas
Marcus Efraimsson
Amal
Cyril Tovena
Torkel Ödegaard
Daniel Mietchen
Carl Bergquist
Joseph Robinson
Marcus Andersson
Rob McGuire
Dominik Prokop
Émile Fugulin
Brenda Harjala
Arve Knudsen