# management-center-docs

**Repository Path**: mirrors_hazelcast/management-center-docs

## Basic Information

- **Project Name**: management-center-docs
- **Description**: Source content for the Hazelcast Management Center documentation
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-16
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= Hazelcast Management Center Documentation
// Settings:
ifdef::env-github[]
:warning-caption: :warning:
endif::[]
// URLs:
:url-org: https://github.com/hazelcast
:url-contribute: https://github.com/hazelcast/hazelcast-docs/blob/develop/.github/CONTRIBUTING.adoc
:url-ui: {url-org}/hazelcast-docs-ui
:url-playbook: {url-org}/hazelcast-docs
:url-staging: https://frosty-curran-1fc0c4.netlify.app/
:url-cc: https://creativecommons.org/licenses/by-nc-sa/3.0/
:url-hz-docs: {url-org}/hz-docs
:url-mc-docs: {url-org}/management-center-docs

image:https://img.shields.io/badge/Build-Staging-yellow[link="{url-staging}"]

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 {url-playbook}[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:

[cols="1m,1m,1m,1m"]
|===
|Repository|Branch|File|Fields

|{url-mc-docs}[management-center-docs]
|main
|docs/antora.yml
a|
- `version`
- `display_version`
- `full-version`

|link:https://github.com/hazelcast/management-center[management-center]
|master
|src/openapi/external/antora.yml
|version

|{url-playbook}[hazelcast-docs]
a|`main` and `develop`
|_redirects
|/management-center/latest-dev/*

|
|
|search-config.json
a| Where the current latest snapshot is used

- `start_urls.tags`
- `start_urls.variables.version`

|{url-hz-docs}[hz-docs]
|main
|docs/antora.yml
|asciidoc.attributes.page-latest-supported-mc

|===

=== Latest Releases

Add the `major.minor` version to the following:

[cols="1m,1m,1m,1m"]
|===
|Repository|Branch|File|Fields

|{url-mc-docs}[management-center-docs]
|v/{major.minor version}
|docs/antora.yml
a|
- `version`
- `display_version`

|link:https://github.com/hazelcast/management-center[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

|{url-playbook}[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/management-center/(?P<version>.*?)/",
  "tags": [
    "management-center-{major.minor version}"
  ],
  "variables": {
    "version": ["{major.minor version}"]
  },
  "selectors_key": "mc"
}
``

|{url-hz-docs}[hz-docs]
a|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:

[cols="1m,1m,1m"]
|===
|Repository|File|Fields

|{url-mc-docs}[management-center-docs]
|docs/antora.yml
a|
- `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

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

. Update the fields mentioned in <<latest-releases, Latest Releases>>.

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

. 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 `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:

.GitHub Actions
[cols="m,a,a"]
|===
|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
|===

== npm scripts

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

.npm scripts
[cols="m,a,a"]
|===
|Script |Description |Notes

|`npm run build`
|Builds a production version of the docs from this repo
|This script depends on Netlify env vars, which you can encode using e.g.: `export NETLIFY=true && export PULL_REQUEST=true && export REPOSITORY_URL=h
ttps://github.com/hazelcast/management-center-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 link:https://github.com/hazelcast/hazelcast-docs/blob/main/antora-playbook.yml[global antora-playbook]. But if you want to build less, please modify the local link:./antora-playbook.yml[antora-playbook].

|`npm run validate-docs`
|Validates docs
|It will take into consideration all content sources taken from the link:https://github.com/hazelcast/hazelcast-docs/blob/main/antora-playbook.yml[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`.

== Contributing

If you want to add a change or contribute new content, see our {url-contribute}[contributing guide].

To let us know about something that you'd like us to change, consider {url-org}/management-center-docs/issues/new[creating an issue].

== License

All documentation is available under the terms of a link:{url-cc}[Creative Commons License].