opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-31 12:32:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs
History
Samuel Alfageme 261191ffd7 Docs: misc. nitpicks to the HTTP API docs (#21758) 
* Replace bash/json with http in http_api codeblocks

Since http is used elsewhere on the API docs and makes the
markdown rendering look different on the blocks that use bash/json

* Fix the annotations API link on 'Features'

- Noticed the Features/Dashboard Features/Annotations link pointing to
the HTTP API was linking itself instead of '../http_api/annotations.md'.
- Also add a link on Dashboard Export and Import to its HTTP API.

* Add missing links to features in API Index

Noticed there was 3 missing references in the API docs index.
- https://grafana.com/docs/grafana/latest/http_api/playlist
- https://grafana.com/docs/grafana/latest/http_api/datasource_permissions
- https://grafana.com/docs/grafana/latest/http_api/external_group_sync

Last two are Grafana Enterprise -only, so created a separate subsection
for them.
2020-01-27 13:41:15 +01:00
..
sources
Docs: misc. nitpicks to the HTTP API docs (#21758)
2020-01-27 13:41:15 +01:00
.gitignore
Docs: Add minimal hugo build, update docs README (#20905)
2019-12-13 15:47:28 +01:00
logo-horizontal.png
Added back logo file (#21198)
2019-12-19 09:09:48 -08:00
Makefile
Docs: Fix getting started links on Windows installation page (#21724)
2020-01-24 19:33:11 +01:00
README.md
Docs: add test for website build (#21364)
2020-01-14 16:26:00 +01:00
versions.json
docs: update versions (#20635)
2019-11-25 15:40:27 +01:00

README.md

Building the docs locally

When you contribute to documentation, it is a good practice to build the docs on your local machine to make sure your changes appear as you expect. This README explains the process for doing that.

Requirements

Docker >= 2.1.0.3

Build the doc site

  1. In the command line, make sure you are in the docs folder: cd docs.
  2. Run make docs. This launches a preview of the docs website at http://localhost:3002/docs/grafana/latest/ which will refresh automatically when changes to content in the sources directory are made.

Content guidelines

Edit content in the sources directory.

Using relref for internal links

Use the Hugo shortcode relref any time you are linking to other internal docs pages.

Edit the side menu

Edit sources/menu.yaml to make changes to the sidebar. Stop and rerun the make docs command for changes to take effect.

Add images

Images are currently hosted in the grafana/website repo.

Deploy changes to grafana.com

When a PR is merged to master with changes in the docs directory, those changes are automatically synched to the grafana/website repo on the docs-grafana branch.

In order to make those changes live, open a PR in the website repo that merges the docs-grafana branch into master. Then follow the publishing guidelines in that repo.