public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: updates for file-based menu (#28500)

Browse Source 
* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
Robby Milo
2020-11-09 12:26:49 -08:00
committed by GitHub
co-authored by Diana Payton
parent a7e092f243
commit abee02dbcd
271 changed files with 260 additions and 1266 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/http_api/_index.md
+1 -5
View File
@@ -3,11 +3,7 @@ title = "HTTP API"
description = "Grafana HTTP API"
keywords = ["grafana", "http", "documentation", "api", "overview"]
aliases = ["/docs/grafana/latest/overview"]
type = "docs"
[menu.docs]
name = "HTTP API"
identifier = "http_api"
weight = 9
weight = 170
+++
docs/sources/http_api/admin.md
-4
View File
@@ -3,10 +3,6 @@ title = "Admin HTTP API "
description = "Grafana Admin HTTP API"
keywords = ["grafana", "http", "documentation", "api", "admin"]
aliases = ["/docs/grafana/latest/http_api/admin/"]
type = "docs"
[menu.docs]
name = "Admin"
parent = "http_api"
+++
# Admin API
docs/sources/http_api/alerting.md
-4
View File
@@ -3,10 +3,6 @@ title = "Alerting HTTP API "
description = "Grafana Alerts HTTP API"
keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts"]
aliases = ["/docs/grafana/latest/http_api/alerting/"]
type = "docs"
[menu.docs]
name = "Alerting"
parent = "http_api"
+++
# Alerting API
docs/sources/http_api/alerting_notification_channels.md
-4
View File
@@ -3,10 +3,6 @@ title = "Alerting Notification Channels HTTP API "
description = "Grafana Alerting Notification Channel HTTP API"
keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts", "notifications"]
aliases = []
type = "docs"
[menu.docs]
name = "Alerting Notification Channels"
parent = "http_api"
+++
# Alerting Notification Channels API
docs/sources/http_api/annotations.md
-5
View File
@@ -3,11 +3,6 @@ title = "Annotations HTTP API "
description = "Grafana Annotations HTTP API"
keywords = ["grafana", "http", "documentation", "api", "annotation", "annotations", "comment"]
aliases = ["/docs/grafana/latest/http_api/annotations/"]
type = "docs"
[menu.docs]
name = "Annotations"
identifier = "annotationshttp"
parent = "http_api"
+++
# Annotations resources / actions
docs/sources/http_api/auth.md
-4
View File
@@ -3,10 +3,6 @@ title = "Authentication HTTP API "
description = "Grafana Authentication HTTP API"
keywords = ["grafana", "http", "documentation", "api", "authentication"]
aliases = ["/docs/grafana/latest/http_api/authentication/"]
type = "docs"
[menu.docs]
name = "Authentication HTTP API"
parent = "http_api"
+++
# Authentication API
docs/sources/http_api/create-api-tokens-for-org.md
+2 -4
View File
@@ -1,9 +1,7 @@
+++
title = "API Tutorial: Create API tokens and dashboards for an organization"
type = "docs"
keywords = ["grafana", "tutorials", "API", "Token", "Org", "Organization"]
aliases =["/docs/grafana/latest/tutorials/api_org_token_howto/"]
[menu.docs]
weight = 150
+++
@@ -13,9 +11,9 @@ Use the Grafana API to set up new Grafana organizations or to add dynamically ge
## Authentication
There are two authentication methods to access the API:
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.
- 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
docs/sources/http_api/curl-examples.md
-2
View File
@@ -2,8 +2,6 @@
title = "cURL examples"
description = "cURL examples"
keywords = ["grafana", "http", "documentation", "api", "curl"]
type = "docs"
[menu.docs]
+++
# cURL examples
docs/sources/http_api/dashboard.md
-4
View File
@@ -3,10 +3,6 @@ title = "Dashboard HTTP API "
description = "Grafana Dashboard HTTP API"
keywords = ["grafana", "http", "documentation", "api", "dashboard"]
aliases = ["/docs/grafana/latest/http_api/dashboard/"]
type = "docs"
[menu.docs]
name = "Dashboard"
parent = "http_api"
+++
# Dashboard API
docs/sources/http_api/dashboard_permissions.md
-4
View File
@@ -3,10 +3,6 @@ title = "Dashboard Permissions HTTP API "
description = "Grafana Dashboard Permissions HTTP API"
keywords = ["grafana", "http", "documentation", "api", "dashboard", "permission", "permissions", "acl"]
aliases = ["/docs/grafana/latest/http_api/dashboardpermissions/"]
type = "docs"
[menu.docs]
name = "Dashboard Permissions"
parent = "http_api"
+++
# Dashboard Permissions API
docs/sources/http_api/dashboard_versions.md
-4
View File
@@ -3,10 +3,6 @@ title = "Dashboard Versions HTTP API "
description = "Grafana Dashboard Versions HTTP API"
keywords = ["grafana", "http", "documentation", "api", "dashboard", "versions"]
aliases = ["/docs/grafana/latest/http_api/dashboardversions/"]
type = "docs"
[menu.docs]
name = "Dashboard Versions"
parent = "http_api"
+++
# Dashboard Versions
docs/sources/http_api/data_source.md
-4
View File
@@ -3,10 +3,6 @@ title = "Data source HTTP API "
description = "Grafana Data source HTTP API"
keywords = ["grafana", "http", "documentation", "api", "data source"]
aliases = ["/docs/grafana/latest/http_api/datasource/"]
type = "docs"
[menu.docs]
name = "Data source"
parent = "http_api"
+++
docs/sources/http_api/datasource_permissions.md
-4
View File
@@ -3,10 +3,6 @@ title = "Datasource Permissions HTTP API "
description = "Data Source Permissions API"
keywords = ["grafana", "http", "documentation", "api", "datasource", "permission", "permissions", "acl", "enterprise"]
aliases = ["/docs/grafana/latest/http_api/datasourcepermissions/"]
type = "docs"
[menu.docs]
name = "Datasource Permissions"
parent = "http_api"
+++
# Data Source Permissions API
docs/sources/http_api/external_group_sync.md
-4
View File
@@ -3,10 +3,6 @@ title = "External Group Sync HTTP API "
description = "Grafana External Group Sync HTTP API"
keywords = ["grafana", "http", "documentation", "api", "team", "teams", "group", "member", "enterprise"]
aliases = ["/docs/grafana/latest/http_api/external_group_sync/"]
type = "docs"
[menu.docs]
name = "External Group Sync"
parent = "http_api"
+++
# External Group Synchronization API
docs/sources/http_api/folder.md
-4
View File
@@ -3,10 +3,6 @@ title = "Folder HTTP API "
description = "Grafana Folder HTTP API"
keywords = ["grafana", "http", "documentation", "api", "folder"]
aliases = ["/docs/grafana/latest/http_api/folder/"]
type = "docs"
[menu.docs]
name = "Folder"
parent = "http_api"
+++
# Folder API
docs/sources/http_api/folder_dashboard_search.md
-4
View File
@@ -3,10 +3,6 @@ title = "Folder/Dashboard Search HTTP API "
description = "Grafana Folder/Dashboard Search HTTP API"
keywords = ["grafana", "http", "documentation", "api", "search", "folder", "dashboard"]
aliases = ["/docs/grafana/latest/http_api/folder_dashboard_search/"]
type = "docs"
[menu.docs]
name = "Folder/dashboard search"
parent = "http_api"
+++
# Folder/Dashboard Search API
docs/sources/http_api/folder_permissions.md
-4
View File
@@ -3,10 +3,6 @@ title = "Folder Permissions HTTP API "
description = "Grafana Folder Permissions HTTP API"
keywords = ["grafana", "http", "documentation", "api", "folder", "permission", "permissions", "acl"]
aliases = ["/docs/grafana/latest/http_api/dashboardpermissions/"]
type = "docs"
[menu.docs]
name = "Folder Permissions"
parent = "http_api"
+++
# Folder Permissions API
docs/sources/http_api/org.md
-4
View File
@@ -3,10 +3,6 @@ title = "Organization HTTP API "
description = "Grafana Organization HTTP API"
keywords = ["grafana", "http", "documentation", "api", "organization"]
aliases = ["/docs/grafana/latest/http_api/organization/"]
type = "docs"
[menu.docs]
name = "Organization"
parent = "http_api"
+++
docs/sources/http_api/other.md
-4
View File
@@ -3,10 +3,6 @@ title = "Other HTTP API "
description = "Grafana Other HTTP API"
keywords = ["grafana", "http", "documentation", "api", "other"]
aliases = ["/docs/grafana/latest/http_api/other/"]
type = "docs"
[menu.docs]
name = "Other"
parent = "http_api"
+++
docs/sources/http_api/playlist.md
-5
View File
@@ -3,11 +3,6 @@ title = "Playlist HTTP API "
description = "Playlist Admin HTTP API"
keywords = ["grafana", "http", "documentation", "api", "playlist"]
aliases = ["/docs/grafana/latest/http_api/playlist/"]
type = "docs"
[menu.docs]
name = "Playlist"
parent = "http_api"
identifier = "http_api_playlist"
+++
# Playlist API
docs/sources/http_api/preferences.md
-4
View File
@@ -3,10 +3,6 @@ title = "HTTP Preferences API "
description = "Grafana HTTP API"
keywords = ["grafana", "http", "documentation", "api", "preferences"]
aliases = ["/docs/grafana/latest/http_api/preferences/"]
type = "docs"
[menu.docs]
name = "Preferences"
parent = "http_api"
+++
# User and Org Preferences API
docs/sources/http_api/reporting.md
-4
View File
@@ -3,10 +3,6 @@ title = "Reporting API"
description = "Grafana Enterprise APIs"
keywords = ["grafana", "enterprise", "api", "reporting"]
aliases = ["/docs/grafana/latest/http_api/reporting/"]
type = "docs"
[menu.docs]
name = "Reporting API"
parent = "http_api"
+++
# Reporting API
docs/sources/http_api/short_url.md
-4
View File
@@ -3,10 +3,6 @@ title = "Short URL HTTP API "
description = "Grafana Short URL HTTP API"
keywords = ["grafana", "http", "documentation", "api", "shortUrl"]
aliases = ["/docs/grafana/latest/http_api/short_url/"]
type = "docs"
[menu.docs]
name = "Short URL"
parent = "http_api"
+++
# Short URL API
docs/sources/http_api/snapshot.md
-4
View File
@@ -3,10 +3,6 @@ title = "HTTP Snapshot API "
description = "Grafana HTTP API"
keywords = ["grafana", "http", "documentation", "api", "snapshot"]
aliases = ["/docs/grafana/latest/http_api/snapshot/"]
type = "docs"
[menu.docs]
name = "Snapshot"
parent = "http_api"
+++
# Snapshot API
docs/sources/http_api/team.md
-4
View File
@@ -3,10 +3,6 @@ title = "Team HTTP API "
description = "Grafana Team HTTP API"
keywords = ["grafana", "http", "documentation", "api", "team", "teams", "group"]
aliases = ["/docs/grafana/latest/http_api/team/"]
type = "docs"
[menu.docs]
name = "Teams"
parent = "http_api"
+++
# Team API
docs/sources/http_api/user.md
-4
View File
@@ -3,10 +3,6 @@ title = "User HTTP API "
description = "Grafana User HTTP API"
keywords = ["grafana", "http", "documentation", "api", "user"]
aliases = ["/docs/grafana/latest/http_api/user/"]
type = "docs"
[menu.docs]
name = "Users"
parent = "http_api"
+++
# User HTTP resources / actions