This repository contains the Antora components for the Hazelcast Platform documentation.
The documentatioan source files are marked up with AsciiDoc.
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.ymlfile. -
The navigation for all modules is stored in the ROOT module’s
nav.adocfile. -
The docs site playbook instructs Antora to automatically build the site using content in the
mainbranch as well as any branches that are prefixed withv/.
Documentation for new releases is hosted in versioned branches that are prefixed with v/. The latest-dev content (snapshot content) is stored in the main branch.
We support documentation for the latest patch releases of minor versions. For example, content for the 5.0 version is hosted in the v/5.0 branch. This branch contains content for the latest patch release of version 5.0.
|
Note
|
The documentation build process is triggered whenever you create a new branch with the v/ prefix, push to an existing v/ branch, or push to the main branch.
|
Add the new snapshot version to the following:
| Repository | Branch | File | Fields |
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
Add the majoer.minor version to the following:
|==sa= |Repository|Branch|File|Fields
|https://github.com/hazelcast/hz-docs[hz-docs]
|v/{major.minor version}
|docs/antora.yml
a|
- version
- display_version
|https://github.com/hazelcast/hazelcast-docs[hazelcast-docs]
a|main and develop
|_redirects
|/hazelcast/latest/*
|
|
|search-config.json
a| Create a new object in the start_urls array.
{
"url": "https://docs.hazelcast.com/hazelcast/(?P<version>.*?)/",
"tags": [
"hazelcast-{major.minor version}"
],
"variables": {
"version": ["{major.minor version}"]
},
"selectors_key": "hz"
}
|https://github.com/hazelcast/management-center-docs[management-center-docs]
a|The v/{version} branch where version is the value of the ascaiidoc.attributes.page-latest-supported-mc field in the docs/antora.yml file of the hz-docs repository
|docs/antora.yml
|asciidoc.attributes.page-latest-supported-hazelcast
Add the full version [cols="1m,1m,1m"] |
|Repository|File|Fields
|https://github.com/hazelcast/hz-docs[hz-docs]
|docs/antora.yml
a|
- full-version
- asciidoc.attributes.page-latest-supported-java-client
=== Patch Releases In the NOTE: As soon as you push content to this branch, GitHub will trigger a new build of the site, which will include your new content. === Creating Release Branches . If you are releasing a new major version, create a release branch from the . Update the fields mentioned in Latest Releases. . Remove the . When you are ready to release, create a maintenance branch from the release branch. + NOTE: As soon as you push the maintenance branch to the repository, GitHub will trigger a new build of the site, which will include your new content. . Make sure to delete the release branch.
+
For example, if you released version == GitHub Actions To automate some elements of the build process, this repository includes the following GitHub Actions: .GitHub Actions [cols="m,a,a"] |
|File |Description |Triggers
|validate-site.yml
|Validates that all interna.l 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
|backport.yml
|Backports commits to maintenance branches
|On a push to the main branch that originated from a pull requesdft with the backport label
== Contributinga 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. == License All documentation is available under the terms of a Creative Commons License |