The generated files will be put in the
docs/ directory (note
the extra s). GitHub serves the website from this directory off the master
Site should be live at localhost:4000
Sanity check the diffs.
git diff HEAD~
Create a pull request for your branch and let somebody review it.
Merge the pull request into the master branch.
We have three main directories:
doc/- original content
docs/- generated website actually served at http://vitess.io/
vitess.io/- all relevant files for the website e.g.
The boiler plate markdown files have multiple purposes:
doc/GitHubWorkFlow.mdis actually served as http://vitess.io/contributing/github-workflow.html because there is the file
To modify our website, you need to:
If you want to add a new page, you must also:
When you add a new section to the menu, please create a new directory below
vitess.io/. For example, the "Contributing" section is served out of
The main file in the section should have
index.md as its boiler plate counter
doc/Contributing.md is included by
vitess.io/contributing/index.md and therefore served as
Please always use absolute paths with a leading
/ e.g. in links to other
documents or images.
There are several files in
doc/ which are currently not visible on
This is fine and accepted. Users can still view them on GitHub.com.
Note that these files should include images using the full path e.g. in
Otherwise GitHub cannot find and show the images.
This section describes how to install Jekyll to generate the website.
./vitess.io/publish-site.shcommands as shown above.
sudo apt-get install -y libreadline-dev
rbenv global 2.2.3
gem install bundler
sudo apt-get install nodejs
ln -s /usr/bin/nodejs $HOME/.rbenv/bin/node
--docker=falseto the commands above.