Skip to content

Documentation Guide

We strive to provide complete, concise and maintainable documentation for the project. To achieve these goals, all contributed documentation should adhere to the guidance provided in this documentation guide, split into the following sub-guides:

Technical context

The repository hosting the documentation for Egeria is separate from the individual code repositories, and is maintained at odpi/egeria-docs .

The documentation itself is all managed as Markdown files for ease of maintenance and readability. We use the MkDocs generator along with the Material for MkDocs theme to generate a static website from these Markdown files. This static website is deployed to the gh-pages branch of the documentation repository, from which GitHub pages then hosts the documentation website itself.

Adding to the documentation

When contributing to the documentation, you can easily use this to test documentation changes out on your own machine locally before committing them in a PR:

  1. On a Mac, just do a brew install mkdocs (requires HomeBrew).
  2. Then do a pip3 install mkdocs-material [--upgrade] (the last bit you might want to add and re-run periodically to keep things up-to-date).
  3. From the site directory of your local clone of this repository, you can then just run:

    $ mkdocs serve
    

... and you'll shortly have a local documentation site running on your local machine, complete with any changes you make (each change you make will auto-refresh the content and your browser).

Look for warnings

As part of running its generator, MkDocs will automatically warn you if it finds any broken links within your documentation. Pay close attention to these, as the PR merge mechanism for documentation will strictly enforce that no broken links are found in order to merge any changes into the main documentation.

Incremental viewing

If you have the mkdocs server running as you edit page source, it will detect changed files and rebuild automatically. However this can take a minute or two. To speed this up to a second or two, use the --dirtyreload flag to mkdocs serve.

Note that any deleted pages will not be removed, and some links may break as a result that would otherwise work with a full reload (i.e. navigation structure changes). See Release notes for further information.

Special handling of index.md

Be aware that the specific theme we use will treat every index.md as an index page for a section: these behave in special ways depending on the level of the navigation in which they appear. Unless you mean to create an overview of some section of the navigation, do not name your Markdown file index.md.

Back to top