mirror of
https://github.com/grafana/grafana.git
synced 2025-01-06 14:13:11 -06:00
2b9d260686
This updates the mkdocs.yml source file such that the HTTP Preferences API is included in the website navigation bar and in the HTTP API overview page. This commit also refreshes the docs/README.md file with more verbose instructions for building and viewing the documentation locally. * Original issue: #5069 Document org & user preferences HTTP docs * Original PR: #5087 Closes #5193
101 lines
4.3 KiB
YAML
101 lines
4.3 KiB
YAML
site_name: Grafana Documentation
|
|
site_url: /
|
|
site_description: Documentation for Grafana, The Graphite and Influxdb dashboard and graph composer
|
|
site_favicon: img/fav32.png
|
|
|
|
dev_addr: '0.0.0.0:8000'
|
|
|
|
repo_url: https://github.com/grafana/grafana/
|
|
|
|
docs_dir: sources
|
|
|
|
include_search: true
|
|
|
|
use_absolute_urls: true
|
|
|
|
# theme: docker
|
|
theme_dir: ./theme/mkdocs/
|
|
theme_center_lead: false
|
|
|
|
copyright: Copyright © 2014-2015, Coding Instinct AB.
|
|
google_analytics: ['UA-47280256-1', 'grafana.org']
|
|
|
|
|
|
pages:
|
|
|
|
# Introduction:
|
|
# - ['index.md', 'Project', 'About Grafana']
|
|
# - ['project/cla.md', 'Project', 'Contributor License Agreement']
|
|
|
|
- ['index.md', '**HIDDEN**']
|
|
- ['installation/index.md', 'Installation', 'Installation']
|
|
- ['installation/debian.md', 'Installation', 'Installing on Debian / Ubuntu']
|
|
- ['installation/rpm.md', 'Installation', 'Installing on RPM-based Linux']
|
|
- ['installation/mac.md', 'Installation', 'Installing on Mac OS X']
|
|
- ['installation/windows.md', 'Installation', 'Installing on Windows']
|
|
- ['installation/docker.md', 'Installation', 'Installing on Docker']
|
|
- ['project/building_from_source.md', 'Installation', 'Building from Source']
|
|
|
|
- ['installation/configuration.md', 'Installation', 'Configuration']
|
|
- ['installation/ldap.md', 'Installation', 'LDAP Integration']
|
|
- ['installation/provisioning.md', 'Installation', 'Provisioning']
|
|
- ['installation/performance.md', 'Installation', 'Performance Tips']
|
|
- ['installation/troubleshooting.md', 'Installation', 'Troubleshooting']
|
|
- ['installation/migrating_to2.md', 'Installation', 'Migrating from v1.x to v2.x']
|
|
|
|
- ['guides/basic_concepts.md', 'User Guides', 'Basic Concepts']
|
|
- ['guides/gettingstarted.md', 'User Guides', 'Getting Started']
|
|
- ['guides/whats-new-in-v3.md', 'User Guides', "What's New in Grafana v3.0"]
|
|
- ['guides/whats-new-in-v2-6.md', 'User Guides', "What's New in Grafana v2.6"]
|
|
- ['guides/whats-new-in-v2-5.md', 'User Guides', "What's New in Grafana v2.5"]
|
|
- ['guides/whats-new-in-v2-1.md', 'User Guides', "What's New in Grafana v2.1"]
|
|
- ['guides/whats-new-in-v2.md', 'User Guides', "What's New in Grafana v2.0"]
|
|
- ['guides/screencasts.md', 'User Guides', 'Screencasts']
|
|
|
|
- ['reference/graph.md', 'Reference', 'Graph Panel']
|
|
- ['reference/singlestat.md', 'Reference', 'Singlestat Panel']
|
|
- ['reference/table_panel.md', 'Reference', 'Table Panel']
|
|
- ['reference/dashlist.md', 'Reference', 'Dashboard List Panel']
|
|
- ['reference/sharing.md', 'Reference', 'Sharing']
|
|
- ['reference/annotations.md', 'Reference', 'Annotations']
|
|
- ['reference/timerange.md', 'Reference', 'Time Range']
|
|
- ['reference/search.md', 'Reference', 'Search']
|
|
- ['reference/templating.md', 'Reference', 'Templating']
|
|
- ['reference/scripting.md', 'Reference', 'Scripting']
|
|
- ['reference/playlist.md', 'Reference', 'Playlist']
|
|
- ['reference/export_import.md', 'Reference', 'Import & Export']
|
|
- ['reference/admin.md', 'Reference', 'Administration']
|
|
- ['reference/keyboard_shortcuts.md', 'Reference', 'Keyboard Shortcuts']
|
|
|
|
- ['datasources/overview.md', 'Data Sources', 'Overview']
|
|
- ['datasources/graphite.md', 'Data Sources', 'Graphite']
|
|
- ['datasources/elasticsearch.md', 'Data Sources', 'Elasticsearch']
|
|
- ['datasources/cloudwatch.md', 'Data Sources', 'CloudWatch']
|
|
- ['datasources/influxdb.md', 'Data Sources', 'InfluxDB']
|
|
- ['datasources/opentsdb.md', 'Data Sources', 'OpenTSDB']
|
|
- ['datasources/kairosdb.md', 'Data Sources', 'KairosDB']
|
|
- ['datasources/prometheus.md', 'Data Sources', 'Prometheus']
|
|
|
|
- ['http_api/overview.md', 'API', 'Overview']
|
|
- ['http_api/auth.md', 'API', 'Authentication API']
|
|
- ['http_api/dashboard.md', 'API', 'Dashboard API']
|
|
- ['http_api/data_source.md', 'API', 'Data Source API']
|
|
- ['http_api/org.md', 'API', 'Organisation API']
|
|
- ['http_api/user.md', 'API', 'User API']
|
|
- ['http_api/admin.md', 'API', 'Admin API']
|
|
- ['http_api/snapshot.md', 'API', 'Snapshot API']
|
|
- ['http_api/preferences.md', 'API', 'Preferences API']
|
|
- ['http_api/other.md', 'API', 'Other API']
|
|
|
|
- ['plugins/index.md', 'Plugins', 'Overview']
|
|
- ['plugins/installation.md', 'Plugins', 'Installation']
|
|
- ['plugins/development.md', 'Plugins', 'Development']
|
|
- ['plugins/apps.md', 'Plugins', 'Apps']
|
|
- ['plugins/datasources.md', 'Plugins', 'Datasources']
|
|
- ['plugins/panels.md', 'Plugins', 'Panels']
|
|
|
|
- ['tutorials/index.md', 'Tutorials', 'Tutorials']
|
|
- ['tutorials/hubot_howto.md', 'Tutorials', 'How To integrate Hubot and Grafana']
|
|
|
|
- ['jsearch.md', '**HIDDEN**']
|