README.md

Velocitas-Docs

This repository contains the source code for the Velocitas Documentation.

📓 Please visit the generated documentation to learn more about Velocitas! https://eclipse.dev/velocitas/

Directory structure

• Markdown files used for the generated documentation exists in the content folder.
• Examples shown in the documentation may exist as source code in the examplesfolder.

Building documentation locally

Using Devcontainer

Velocitas-docs provides a Devcontainer that can be used to build and run the documentation server locally. As the last step when starting the devcontainer the webserver is started, and it is reachable outside Devcontainer. If you update source pages the local server will be automatically updated.

Web Server is available at http://localhost:1313/velocitas/ (bind address 127.0.0.1)

Using Native Environment

It is also possible to build and run the documentation outside the Devcontainer. If using Debian you could install Hugo like this:

sudo apt install hugo

For other environments please visit Hugo documentation.

Then you can build and start a local hugo server and access documentation at http://localhost:1313.

/usr/bin/hugo server -D -s .

If you update source pages the local server will be automatically updated.

Deploying official documentation

The Velocitas Documentation Site is not automatically updated when something is merged to main. Instead a Velocitas committer needs to manually run the Publish Documentation workflow. That results in that the docs branch is updated and triggers the pages-build-deployment workflow that publishes the new version to the Velocitas Documentation Site.

Release Testing

Before deploying the official documentation by triggering the Publish Documentation workflow the following actions must be performed:

• Run the hugo server on localhost
• Verify that appearance is similar to the currently deployed official version and links are working as expected.
• Upload the new main to a fork that you control with GitHub Pages enabled
• Verify that you can run the Publish Documentation workflow and that the result is published to your pages. Use a GitHub Pages configuration where the docs branch is used and where the result will be available at https://<your userid or organization>.github.io/velocitas-docs/.
• After triggering Publish Documentation workflow on the official velocitas-docsrepository verify that results looks like expected.

Theme Upgrade

Velocitas-docs use the Docsy Theme. To upgrade you need to change the docsy version in postCreateCommand.sh and rebuild the devcontainer. This will result in updated versions of go.modand go.sum.

Community

• GitHub Issues
• Mailing List
• Contribution