Commit Graph

2827 Commits

Author SHA1 Message Date
Marc-Antoine Leclercq 67a7e03615 Documentation: Specify usage of datasource whitelist (#22412)
* Specify usage of datasource whitelist

Added a sentence explaining the data_source_proxy_whitelist  property does not have any effect on pgsql mssql and mysql.

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2020-02-26 15:57:11 +01:00
Marcus Andersson 6bc369629d Docs: adding first version of the auto-generated packages API docs. (#22107)
* 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 menu options.

* added parameters and return values.

* Fixed merge error.

* Added first version of auto-generated docs.

* 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.

* updated api docs.

* lerna bootstrap.

* added eror to the ingore words list.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

* updated the autogenerated dosc.

* adding missing new line.
2020-02-26 10:03:53 +01:00
Agnès Toulet 1dd404a1fb Core: Make application title customizable for WL (#22401)
* Core: Add custom app title

* Docs: Update White Labeling title customization

* Core: set back export for Branding types
2020-02-25 15:18:37 +01:00
Agnès Toulet 7f86f2d4f3 Docs: Add info on active LDAP sync (#22347)
* Docs: Add info on active LDAP sync

* Update docs/sources/enterprise/enhanced_ldap.md

Co-Authored-By: Leonard Gram <leo@xlson.com>

* Docs: remove usage of "he" in LDAP sync

Co-authored-by: Leonard Gram <leo@xlson.com>
2020-02-24 10:48:07 +01:00
Torkel Ödegaard 7946eee389 Docs: Fixed formatting issue in new stat docs (#22390)
* Docs: Fixed formatting issue in new stat docs

* Fixed newline
2020-02-24 10:03:57 +01:00
Torkel Ödegaard 8c2107cd35 Docs: New doc pages for panels Stat, Gauge & Bar Gauge (#22335)
* Initial take

* inital gauge docs

* Updated and added bar gauge docs

* Updated based on feedback
2020-02-21 15:23:20 +01:00
eldin 21015b0899 Docs: Update white-labeling.md (#22224) 2020-02-20 16:01:58 +01:00
Mohit Nain 458eccbfc0 Suggesting couple of changes to the document (#22298)
* Suggesting couple of changes to the document

Line 15 should be modified to use your application instead of an application, same way it is being used in other auth docs.

typo in line 76, can is repeated twice . Correcting that typo

* Update docs/sources/auth/gitlab.md

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

* Update gitlab.md

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-20 10:19:39 +01:00
Mohit Nain 0418fb3f4f Correcting Line 22 (#22292)
* Correcting Line 22

Menu drop down is correct description for the control , rather than the menu that drops down

* Update docs/sources/auth/google.md

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

* Update docs/sources/auth/google.md

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

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-20 10:16:25 +01:00
Rob McGuire ccdd964811 Docs: Fix "enable" steps formatting (#22324)
* Docs: Fix "enable" steps formatting

* Update docs/sources/features/datasources/testdata.md

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

Co-authored-by: Daniel Lee <dan.limerick@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-20 10:14:23 +01:00
Diljit PR 48648561fa [Docs] Improvised instructions for adding data source. (#22305) 2020-02-20 10:03:52 +01:00
Mohit Nain 9a65c5a90d Docs: Couple of changes to the document (#22291)
* Couple of changes to the document

Correcting a typo in line 53
Line 226 should be re-written as "To easily configure"

* Update docs/sources/auth/generic-oauth.md

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

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-02-19 14:56:12 -08:00
Mohit Nain 5e1d1c1d01 Docs: Typo correction in Line 19 (#22297)
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-02-19 14:54:47 -08:00
Diana Payton b81c842510 Update rpm.md (#22284)
Minor format edits
2020-02-19 11:53:26 +01:00
Rob McGuire 33fae87899 Docs: Fix TestData docs (#22279)
* Update TestData docs

Fixes TestData docs by correcting name, installation instructions, etc. Should prevent issues like #16386.

- Fix name: `Grafana TestData` -> `TestData DB`
- Fix "Enable" section instructions
- Fix "Dashboard" section instructions
- Fix grammar

* Bold clickable items, list step-by-step instrs.

* Apply suggestions from code review

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-18 15:06:33 -08:00
Diana Payton 131610e8f7 Update mac.md (#22280)
Minor link update
2020-02-18 13:23:07 -08:00
Diana Payton e08b39d4f0 Docs: minor fixes (#22223)
* Update enhanced_ldap.md

* Update ldap.md

* Minor fixes
2020-02-18 12:28:59 -08:00
Diana Payton 37aa584a54 Docs: Minor typo fix (#22221) 2020-02-18 09:08:49 -08:00
ROY 45da3b77a8 Update timeseries.md (#20795)
* Update timeseries.md

Update to docs-imagebox for the image link.

* Update docs/sources/guides/timeseries.md

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

Co-authored-by: Marcus Olsson <accounts+github@marcus.se.net>
2020-02-18 01:19:48 +01:00
Diana Payton 69c512d5f4 Docs: Update windows.md (#22185)
Added missing link
2020-02-14 10:20:38 -08:00
Diana Payton ffde18eedf Docs: Add linking topic (#21986)
* Create linking.md

* Update linking.md

* Updated menu and edited linking content

* Changed file name

* Update navigation-links.md
2020-02-14 10:19:26 -08:00
Diana Payton 0d3d8edb92 Docs: Refactored Enterprise side menu (#22189)
* Refactored Enterprise side menu

* Update menu.yaml

* Fixed links

* Update menu.yaml
2020-02-14 09:34:39 -08:00
Arve Knudsen 019834ae12 Alerting: Update the types of recipient supported by the Slack notifier (#22205)
* Alerting: Update types of supported Slack recipients
* Document Slack recipient requirements
2020-02-14 17:11:23 +01:00
Jeet Parekh f1989f1bfc docs: change URL occurences to uppercase (#22151)
* change URL occurences to uppercase

* Update docs/sources/tutorials/iis.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-14 08:11:08 -08:00
annelaurefroment 56cd845e97 Docs: Fix link for provisioning data sources (#22159)
fixing link for provisioning data sources to use relref
2020-02-14 07:06:18 -08:00
Alexander Zobnin f2fc7aa3aa Azure OAuth: enable teamsync (#22160)
* Azure OAuth: extract groups from token for teamsync

* Docs: changed some headers

* Azure OAuth: fix tests

* Azure OAuth: fix linter error (simplify)

* Azure OAuth: add allowed_groups option

* Azure OAuth: docs for team sync and allowed_groups

* Azure OAuth: tests for allowed_groups

* Update docs/sources/auth/azuread.md

Co-Authored-By: Leonard Gram <leo@xlson.com>

Co-authored-by: Leonard Gram <leo@xlson.com>
2020-02-14 14:03:00 +03:00
Diana Payton 961cb6b284 Docs: Organize basic concepts and getting started (#21859)
* Update shortcuts.md

Removed content that was out-of-date and redundant with the UI.

* Added panels.md

* Added dashboards.md

* Added data-sources.md

* Update data-sources.md

* Sorted basic concepts into other topics

* Update docs/sources/menu.yaml

Co-Authored-By: Marcus Olsson <accounts+github@marcus.se.net>

* Update panels.md

* Update data-sources.md

Co-authored-by: Marcus Olsson <accounts+github@marcus.se.net>
2020-02-13 13:04:05 -08:00
Mohit Nain 824f7362d4 Docs: Suggesting few changes to the doc (#22115)
* Suggesting few changes to the doc

1. Note should be followed by a dot (.)
2. Correcting a typo in default
3.  Re-writing sub sentence to make reading better

* Update docs/sources/installation/configuration.md

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

* Update configuration.md

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-02-13 10:57:13 -08:00
Mohit Nain 4f94a4c495 Docs: Update phrasing line 35 (#22152)
Idea is to provide information to the user that query can be executed on any data source that is available in grafana, therefore suggested little modification
2020-02-13 10:34:58 -08:00
Mohit Nain 63d999a739 Docs: Correcting Typo in Line131 (#22155) 2020-02-13 10:34:01 -08:00
twendt ff6a082e23 Auth: Azure AD OAuth (#20030)
* Implement Azure AD oauth

* Use go-jose and cleanup

* Update go-jose in go.mod

* cleanup

* Add unit tests

* Fix scopes

* Add documentation page

* Improve documentation

* Convert extract_role into function.

* Do not use upn and replace unique_name with preferred_username

* Configure login button

* Use official microsoft icon and color from branding guideline.

* Add Azure AD config section in sample.ini.
2020-02-13 12:12:25 +03:00
Arve Knudsen cece9547ae Docs: Fix port config list formatting (#22113)
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-02-12 12:05:37 -08:00
Arve Knudsen 6f09bc9fb4 Fix mentioning Slack users/groups (#21734)
* alerting/slack: Allow mentioning users, groups, and channels separately
2020-02-11 21:43:28 +01:00
Diana Payton 717e1a3b2b Docs: Update rules.md (#21989)
Minor edits
2020-02-11 10:37:35 -08:00
Diana Payton 929cbd3315 Docs: Update metrics.md (#21988) 2020-02-11 10:36:45 -08:00
Diana Payton e1518666dd Docs: Update dashboard.md (#21951) 2020-02-11 10:36:18 -08:00
Diana Payton 4642a76ad8 Docs: Added release notes tag (#22012) 2020-02-11 10:35:44 -08:00
Agnès Toulet 534295a9ae Docs: add LDAP active sync limitation for single bind configuration (#22098)
* Docs: add LDAP active sync limitation for single bind

* Docs: update header for LDAP active sync limitation

Co-Authored-By: Leonard Gram <leo@xlson.com>
2020-02-11 17:58:39 +01:00
Jim Johnson b55a39a221 Docs: Update behind_proxy.md to include HTTPS and URL rewrite example (#21832) 2020-02-11 17:55:02 +01:00
Diana Payton 2a2b33bb55 Docs: Image rendering improvements (#22084) 2020-02-11 07:38:13 -08:00
Bruce Merry 02c779cfa3 Prometheus: make $__range more precise (#21722)
* Make $__range more precise in Prometheus

It is now always equivalent to `${__range_s}s`, rather than rounding
down to an integer multiple of the biggest possible unit. For example,
a range of 47 hours is now represented as `169200s` rather than `1d`.

Closes #21689.

* Update a unit test to match new __range calc
2020-02-11 14:28:06 +01:00
Alex Khomenko 94b66258b5 Docs: fix minor typos in datasources.md (#22092) 2020-02-11 14:32:20 +02:00
Diana Payton efbe5e8729 Docs: Fix broken link (#22010)
* Fix broken link

* Update docs/sources/installation/configuration.md

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

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-02-10 08:59:24 -08:00
Beck 5dd170d2e9 Docs: Fix formatting typo (#22067) 2020-02-10 08:43:48 -08:00
Even Thomassen 258b507179 Docs: Clarify that extraction of zip is required to install plugin (#22061) 2020-02-10 13:40:54 +01:00
Ivana Huckova c16040a4a6 Docs: Documentation for 6.6 Explore and Logs panel features (#21754)
* Add documentation for explore and logs panel features

* Update docs/sources/features/explore/index.md

* Docs: Update

* Update docs/sources/features/panels/logs.md

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

* Update docs/sources/features/panels/logs.md

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

* Update docs/sources/features/explore/index.md

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

* Update docs/sources/features/explore/index.md

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

* Update docs/sources/features/explore/index.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-05 22:01:34 +01:00
Diana Payton caac9d83ca Docs: Added developer-resources.md (#21806)
* Added developer-resources.md

Added Developer resources and updated menu.yaml file

* Updated menu.yaml

Updated menu.yaml, changed folder name, and removed redundant file building_from_source.md and containing folder

* Removed links to deleted file
2020-02-04 13:40:25 -08:00
Jacopo Rota 21340a5ece Docs: Update dashboard.md (#21896)
Fix typo in templating JSON
2020-02-03 08:42:35 -08:00
Diana Payton 98c912e1a7 Docs: Update dashboard.md (#21200) 2020-02-03 08:00:08 -08:00
Stefan 0953dae221 Docs: Make upgrading instructions for Docker work (#21836)
One has to use "grafana/grafana" image - only using "grafana" will
result in an error message like this:
Error response from daemon: pull access denied for grafana, repository does not exist or may require 'docker login'

It's a good idea to daemonize new container. The install instructions
for Docker do this, and this instructions assume that running container
already is daemonized (otherwise you wouldn't have to stop it).

Best practise would be to create a new container, then stop old one and
start new one - this would reduce downtime. To keep instructions simple
and understandable, I didn't include that.
2020-02-03 07:59:24 -08:00