Skip to content

skupperproject/skupper-docs

Repository files navigation

Skupper Documentation

This repo is used to document Skupper using AsciiDoc markup. The output is published at Skupper - Documentation.

Contributing to the documentation

This section explains how to edit and create documentation PRs.

If you only want to make a small update, you might want to just edit the file and make the PR using your standard process.

If you want to preview changes for more complex contributions, follow this procedure.

Procedure
  1. Start the build:

    $ bash scripts/convert-all.sh
  2. See the build directory for the HTML output.