Flow Documentation

This repository contains the Antora components for the Flow documentation.

The documentation source files are marked up with AsciiDoc.

Docs Structure

This section describes some important information about how this repository is structured:

• The component name, version, and start page are configured in each branch’s antora.yml file.

• The navigation for all modules is stored in the ROOT module’s nav.adoc file.

GitHub Actions

To automate some elements of the build process, this repository includes the following GitHub Actions:

Table 1. GitHub Actions

File	Description	Triggers
validate-site.yml	Validates that all internal and external links are working	On a pull request to the main, archive, and v/ maintenance branches
build-site.yml	Builds the production documentation site by sending a build hook to Netlify (the hosting platform that we use)	On a push to the main branch and any v/ maintenance branches

Contributing

If you want to add a change or contribute new content, see our contributing guide.

To let us know about something that you’d like us to change, consider creating an issue.

npm scripts

For deployment and development this repository includes the following npm scripts:

Table 2. npm scripts

Script	Description	Notes
npm run build	Builds a production version of the docs from this repo	This script depends on Netlify env vars (REPOSITORY_URL and BRANCH) which you can encode using e.g.: export REPOSITORY_URL=https://github.com/hazelcast/hz-docs && export BRANCH=pull/445/head && npm run build You should generally just use build-local though.
npm run build-local	Builds a local version of the docs from this repo	By default, it will build all content sources taken from the global antora-playbook. But if you want to build less, please modify the local antora-playbook.
npm run validate-docs	Validates docs	It will take into consideration all content sources taken from the global antora-playbook.
npm run check-orphan-pages	Checks orphan pages

Note	Before running any of the scripts please make sure you have installed all latest npm packages via npm i.

License

All documentation is available under the terms of a Creative Commons License