Hazelcast CLC Documentation

This directory contains the Antora components for the Hazelcast CLC 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.

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`, and `.z` 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 `.z` maintenance branches

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.

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