opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 19:02:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Simplify headings and make active (#20163)

Browse Source 
* 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 75cbc6303c9f77997b5fd8d26e48802e8e7a859e.

* Docs: Docs: Add additional capitalization rules

* Docs: Simplify headings and make active #19268
This commit is contained in:
Brenda Harjala
2019-11-05 01:23:00 -08:00
committed by Marcus Olsson
parent add0614aee
commit 5b1ac78004
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/installation/upgrading.md
View File

@ -28,7 +28,7 @@ You can update all plugins using
grafana-cli plugins update-all
```
## Database Backup
## Database backup
Before upgrading it can be a good idea to backup your Grafana database. This will ensure that you can always rollback to your previous version. During startup, Grafana will automatically migrate the database schema (if there are changes or new tables). Sometimes this can cause issues if you later want to downgrade.

8
docs/sources/tutorials/api_org_token_howto.md
View File

@ -1,5 +1,5 @@
+++
title = "API Tutorial: How To Create API Tokens And Dashboards For A Specific Organization"
title = "API Tutorial: Create API tokens and dashboards for an organization"
type = "docs"
keywords = ["grafana", "tutorials", "API", "Token", "Org", "Organization"]
[menu.docs]
@ -7,7 +7,7 @@ parent = "tutorials"
weight = 10
+++
# API Tutorial: How To Create API Tokens And Dashboards For A Specific Organization
# API Tutorial: Create API tokens and dashboards for an organization
Use the Grafana API to setup new Grafana organizations or to add dynamically generated dashboards to an existing organization.
@ -18,7 +18,7 @@ There are two authentication methods to access the API:
- Basic authentication: A Grafana Admin user can access some parts of the Grafana API through basic authentication.
- API Tokens: All organization actions are accessed through an API Token. An API Token is associated with an organization. It can be used to create dashboards and other components specific for that organization.
## How To Create A New Organization and an API Token
## How to create a new organization and an API Token
The task is to create a new organization and then add a Token that can be used by other users. In the examples below which use basic auth, the user is `admin` and the password is `admin`.
@ -48,7 +48,7 @@ The task is to create a new organization and then add a Token that can be used b
Save the key returned here in your password manager as it is not possible to fetch again it in the future.
## How To Add A Dashboard
## How to add a dashboard
Using the Token that was created in the previous step, you can create a dashboard or carry out other actions without having to switch organizations.

2
docs/sources/tutorials/ha_setup.md
View File

@ -1,5 +1,5 @@
+++
title = "Setup Grafana for High availability"
title = "Setup Grafana for high availability"
type = "docs"
keywords = ["grafana", "tutorials", "HA", "high availability"]
[menu.docs]

2
docs/sources/tutorials/hubot_howto.md
View File

@ -1,5 +1,5 @@
+++
title = "How To integrate Hubot and Grafana"
title = "How to integrate Hubot and Grafana"
type = "docs"
keywords = ["grafana", "tutorials", "hubot", "slack", "hipchat", "setup", "install", "config"]
[menu.docs]