NOTE: Please don't change files under site/ directly! As they will be overriden when you do mkdocs build
- Install mkdocs, as specified in http://www.mkdocs.org/#installation (note: Please use linux if possible, there is some encoding issue which require manual fix on Windows)
- Make changes under /docs
- Test the changes locally, by
mkdocs serve
- Generate the site files
mkdocs build
, it will render the markdown file as html file and save the result to site/ - Make a PR
- After it is merged, check http://www.gearpump.io to see the result.