IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-12-01 21:19:28 -06:00
Code Issues Packages Projects Releases Wiki Activity
38,416 Commits 5,114 Branches 538 Tags 1.9 GiB
85cda0db69
Commit Graph

192 Commits

Author SHA1 Message Date
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
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
Diana Payton
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.

* Update windows.md
 2019-12-30 07:53:38 -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
Hugo Häggmark
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
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
Brenda Harjala
662e514f1d Update services.md (#20604) 
Fixed a typo.
 2019-11-23 13:03:59 +01: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
Arve Knudsen
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
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
651fac3e5f
Update documentation.md 
Minor edit
 2019-10-16 19:52:36 -07:00
Oddlittlebird
830cd21cd5 Edited Contribute docs 
Edited several docs in the contribute folder.
 2019-10-16 19:49:47 -07:00
Marcus Olsson
7963422df0
Docs: Add database architecture docs (#19800) 2019-10-15 15:05:38 +02: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
Marcus Olsson
2bdd119976
Docs: Link to architecture docs from Developer guide (#19778) 
* Link to architecture docs from Developer guide

* Fix link
 2019-10-12 11:18:33 +02:00
Marcus Olsson
6798ad9762
Docs: Add docs on services (#19741) 
* Add docs on services

* Apply suggestions from code review

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

* Fix review comments

* Extract communication to its own document

* Minor fixes

* Minor fix

* Apply suggestions from code review

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

* Add comment on exported field
 2019-10-11 18:26:18 +02:00
vishesh92
fbe0bc6fce Docs: Fixes go get command in developer guide (#19766) 2019-10-11 14:08:48 +01: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
Marcus Olsson
957b552dd1
Docs: Add Troubleshooting section to Developer guide (#19721) 
* Add Troubleshooting section to Developer guide

* Remove unintended newline
 2019-10-09 10:01:05 +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
Marcus Olsson
096e0e761e
Docs: Simplify README (#19702) 
* Simplify README

* Fix review comments

* Rename Developer guide
 2019-10-08 17:22:37 +02:00
Marcus Olsson
9bff81e590
Docs: Move dev guide from README (#19707) 
* Add docs for overriding default configuration

* Add instructions for building Docker image

* Add docs for end-to-end tests

* Rename to Developer guide
 2019-10-08 17:16:21 +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
f2089bab31
Docs: Move issue triage docs to contribute (#19652) 2019-10-07 11:03:02 +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