#Editing CSE Documentation
CSE uses Github Pages to publish documentation. Follow the steps shown below to enable documentation in the master repo or a fork.
- Go to
Settingson your Github Project. It’s a button at the top of the main project page. (If you do not see the button you may need to get admin access enabled on your account.)
- Scroll down to the Github Pages section. Select master/docs as the source for Github Pages.
- Save your changes.
It may take a few minutes for the change to propagate. When it is complete
you will see a notice like
Your site is published at https://<name>.github.io/container-service-extension/. Point your browser to that URL to see
the generated documentation.
How Rendering Works
Github Pages renders .md files using Jekyll. You can read more about Jekyll at jekyllrb.com. The documentation sources must be in the master branch and directory selected in Settings.
CSE documentation has a header, left-hand navigation, right-side content, and a footer. The files that make this happen are organized as follows.
- The Jekyll site configuration is in _config.yml
- The template used to lay out page html is in _layout/default.html
- The navigation menu is in _data/navigation.yml
- The code that generates the navigation links is in _includes/navigation.hml.
- The content is in files labeled in all-caps starting with INTRO.md.
The HTML layout assumes HTML5. It will not display correctly on older browsers.
Making Changes and Testing Them
Just edit files in the docs directory and check them in!
Content changes do not require any special knowledge of HTML:
- Add new files e.g. FOO.md or edit existing ones.
- Edit _data/navigation.yml to add nav links to new pages and sections.
- If you make content changes that affect navigatation test them fully to avoid broken links.
If you need to change the page layout it’s a good idea to learn about how Jekyll works first. (Start with this tutorial.)
You’ll also need to understand CSS since we use it to control alignment in the browser.
Before checking in it’s an excellent idea to test your changes using a local version of Jekyll. See Setting up your GitHub Pages site locally with Jekyll for a helpful guide. The short version of the commands looks like the following Mac OS X example:
# Check for Ruby version 2.x.x and ensure bundler gem is installed. ruby --version gem install bundler # Cd to directory and install Jekyll components. cd docs/ bundle install # Run Jekyll server. bundle exec jekyll serve
You can access the locally served content by openining a browser on http://localhost:4000.