phantomjinx/website

Hawtio Website

Hawtio website

https://hawt.io

This website is built with Gatsby and the documentation is rendered using Antora. For more info on the tools, refer to each documentation:

• https://www.gatsbyjs.com/docs/
• https://docs.antora.org/antora/latest/

Prerequisites

You must have the following tools installed:

• Node.js (>=18)
• Yarn (>=3)

Develop

To develop and test the website locally, install dependencies for the project:

yarn install

Then run this command to develop:

yarn start

The website built with Gatsby will be available at http://localhost:8000/, and the documentation by Antora will be at http://localhost:8001/.

While the changes under src/ are automatically detected and rebuilt by the gatsby develop feature, those under modules/ are not. You need to manually run the following command to update the documentation in preview:

yarn build:docs

Deploy

This command will locally build the website and documentation and merge them to public/:

yarn build

You can check the local build with the following command:

npx http-server public/

After you made changes to the docs and confirmed they work locally, you can submit a pull request. Once it's merged, it will be automatically deployed by GitHub Actions.

Contribute

Contributions are always welcome!

If you find anything to fix or improve in our docs, modify source files under src/ or modules/ and submit a pull request. Once the pull request is merged it is automatically published by the GitHub workflow.