IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
df6a4a435c
grafana/docs
History
flopp999 df6a4a435c
Text change in search () 
* Text change

made it more understandable that this is a search field

* Made "New Folder"-button green

Since New Dashboard was green I thought New Folder; Import also would be green. Green seems to be the color for creating new items

* Update playlist_search.html

* change search text

* wrong link

* Update playlist.md

* Update manage_dashboards.html

* Update manage_dashboards.html

* replaced Filter

* replaced Filter

* replaced Filter

* replaced filter

* changed text for placeholder

* Update UsersActionBar.tsx

* Update UserListAdminPage.tsx

* update snapshots

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
2020-03-31 14:06:07 +02:00
..
sources Text change in search () 2020-03-31 14:06:07 +02:00
.gitignore Docs: Add minimal hugo build, update docs README () 2019-12-13 15:47:28 +01:00
logo-horizontal.png Added back logo file () 2019-12-19 09:09:48 -08:00
Makefile Docs: Fix getting started links on Windows installation page () 2020-01-24 19:33:11 +01:00
README.md Docs: add test for website build () 2020-01-14 16:26:00 +01:00
versions.json docs: update versions () 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.