Release: Documentation Setup

Release: Documentation Setup

This page outlines the steps taken to prepare the documentation for new version release.

Changes to be made in longhorn-product-docs

1. Duplicate the existing version-<current-version> folder:

   • Created a copy of the version-<current-version> folder as the base for the new release.

2. Rename the copy to version-<new-version>:

   • Example: Rename version-1.9.0 to version-1.10.0.

3. Update antora.yml file:

   • Modify the version and display_version fields in antora.yml file of current-version and new-version.
   • The version should be Dev, the previous version becomes Latest.

4. Update playbook configuration

   • Add the new version to the start_paths in both playbook files (lh-local-playbook.yml and lh-remote-playbook.yml).
   • This allows Antora to discover and include the new version during the site build.

Changes to be made in product-docs-playbook

1. Update playbook configuration:

   • Add the new version to the start_paths in both playbook files (product-docs-playbook-local.yml and product-docs-playbook-remote.yml).

2. Update articles listing configuration:

   • Add the release date of the new version and update links in the articles-listing.conf file.

Pull Requests References

longhorn-product-docs

• 222
• 181
• 182

product-docs-playbook

• 137
• 108
• 94