6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
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
- In the command line, make sure you are in the docs folder:
cd docs. - Run
make docs. This launches a preview of the docs website athttp://localhost:3002/docs/grafana/latest/which will refresh automatically when changes to content in thesourcesdirectory 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.