Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.74 KB
Raw

Skupper website

main

Project commands

You can use the ./plano command in the root of the project to perform project tasks. It accepts a subcommand. Use ./plano --help to list the available commands.

Rendering the site

You can use the ./plano render command in the root of the project to render the site:

$ ./plano render
--> render
Rendering input files
<-- render
OK (0.21s)

For development, you can serve the site locally. Any changes you make to the input files are rendered on demand.

$ ./plano serve
--> serve
Rendering input files
Watching for input file changes
Serving at http://localhost:8080
Starting LiveReload v0.9.1 for /home/jross/code/skupper-website-ssorj/output on port 35729.

If you change any of the files or settings in the config or includes directories, you need to use the --force option with render or serve in order to re-render everything in light of the changes.

Generating the docs

The docs source is in a distinct repo, skupper-docs, and are written in AsciiDoc.

  1. Run ./plano update-skupper-docs to retrieve the latest version of AsciiDoc files from the main branch of skupper-docs.
  2. Run ./convert-all.sh to create Markdown files.
  3. Run ./plano test to run tests and populate the docs directory of this repo with the HTML files generated from the Markdown files.

Updating the site for new Skupper releases

The generate-releases command fetches release data from GitHub and updates the site for new releases.

./plano generate-releases
./plano render --force