Skip to content

Latest commit

 

History

History
193 lines (141 loc) · 5.98 KB

README.adoc

File metadata and controls

193 lines (141 loc) · 5.98 KB
Raw

Hazelcast Management Center Documentation

Build Staging yellow

This repository contains the Antora components for the Hazelcast Management Center 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.

  • The docs site playbook instructs Antora to automatically build the site using content in the main branch as well as any branches that are prefixed with v/.

Release Workflow

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.

Snapshot Releases

Add the new snapshot version to the following:

Repository Branch File Fields

management-center-docs

main

docs/antora.yml

  • version

  • display_version

  • full-version

management-center

master

src/openapi/external/antora.yml

version

hazelcast-docs

main and develop

_redirects

/management-center/latest-dev/*

search-config.json

Where the current latest snapshot is used

  • start_urls.tags

  • start_urls.variables.version

hz-docs

main

docs/antora.yml

asciidoc.attributes.page-latest-supported-mc

Latest Releases

Add the major.minor version to the following:

Repository Branch File Fields

management-center-docs

v/{major.minor version}

docs/antora.yml

  • version

  • display_version

management-center

The major.minor or .z branch of the new latest version of Management Center.

NOTE: If a .z branch exists, make this changes before creating a maintenance branch off of it.

src/openapi/external/antora.yml

version

hazelcast-docs

main and develop

_redirects

/hazelcast/latest/*

search-config.json

Create a new object in the start_urls array.

{ "url": "https://docs.hazelcast.com/management-center/(?P<version>.*?)/", "tags": [ "management-center-{major.minor version}" ], "variables": { "version": ["{major.minor version}"] }, "selectors_key": "mc" }

hz-docs

The v/{version} branch where version is the value of the asciidoc.attributes.page-latest-supported-hazelcast field in the docs/antora.yml file of the management-center-docs repository

docs/antora.yml

asciidoc.attributes.page-latest-supported-mc

Add the full version major.minor.patch to the following:

Repository File Fields

management-center-docs

docs/antora.yml

  • full-version

Patch Releases

In the v/ branch for the minor version whose patch you are releasing, update the asciidoc.attributes.full-version field in the antora.yml file to the new patch version. For example, if you are releasing version 5.0.3, find the v/5.0 branch and update the asciidoc.attributes.full-version field in the antora.yml file with 5.0.3.

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

  1. If you are releasing a new major version, create a release branch from the main branch.

    For example, if you are releasing version 5.1, create a new release branch named 5.1 from the main branch.

  2. Update the fields mentioned in Latest Releases.

  3. Remove the prerelease: true field and the snapshot: true field from the docs/antora.yml file of the management-center-docs repository.

    Important
    		 If you are creating a branch for a beta release, do not remove the prerelease field.

  4. 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.

  5. Make sure to delete the release branch.

    For example, if you released version 5.1, delete the 5.1 branch. This step helps to keep the repository clean of release branches.

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 master, archive, and v/ 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 master branch and any v/ 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.

License

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