Managing Versions

Using DeveloperHub, you can version your documentations. The default version is called v1.0, it is up to you to define how you call your versions. Semantic versioning is not required, so you can use words such as "beta", "alpha" and "latest" along actual version numbers.

Versioning is very powerful. When pages are linked inside a version, and that version is cloned, all the page links are updated accordingly to the match the new version.

Creating Versions (Cloning)

New versions are always cloned from other versions, to clone a version:

1. Click on Version in the sidebar.
2. Select the version to clone from.
3. Click on "Clone from current version".

Publishing Versions

Versions by default are not published. Once you are ready to publish (or to unpublish):

1. Click on Version in the sidebar.
2. Below the version title at the top, click on the publishing state and modify it as needed.

When a version gets published, only published documentation and API references in the version would be viewable by readers. Unpublishing a version makes the version and all its contents unviewable by readers, but it does not modify the publish state for its documentation and API reference.

When a version is published, it will appear with a green dot next to it in the sidebar. When the version is unpublished, it will appear with a red dot next to it.

Deleting Versions

To delete a version:

• Click on Version in the sidebar.
• Select the version to delete.
• Click on the red bin next to the Version title at the top.
• Confirm your deletion.

Ordering Versions

To change a version order in the picker:

• Click on Version in the sidebar.
• Drag the version to be ordered from the handle
• Drop the version in the desired place.

If the version is ordered first and is published, then it will be the default version to load for your readers. A default badge would show to indicate that it is default.

The default version does not show its slug in the live page links, for example, if version 1.0 was default for this documentation project then:

https://docs.developerhub.io/support-center/managing-versions would implicitly mean that it should load the default version, which is version 1.0. Using https://docs.developerhub.io/v1.0/support-center/managing-versions would yield the same result.

Moving Readers to New Version

If your readers have bookmarked pages from older versions, or are unaware that your documentation is versioned, then you might want to notify them using a banner at the top of the page that there is a newer version. You can do so using an advanced setting by setting warnings.oldVersion to true.

Banner suggesting to the reader that there's a newer version

Locking Versions

Versions can be locked when they no longer should have their documentation and API references editable. When a version is locked, documentation and API references cannot be:

• Created.
• Edited.
• Removed.
• Published.

This also applies to changes made using the APIAPI.

To lock/unlock a version:

• Click on Version in the sidebar.
• Select the version to be locked/unlocked.
• Open the version settings .
• Check or uncheck the setting Locked.

A lock icon would show next to the locked version and the buttons to save drafts or publish would be replaced by a button having "Locked" on it.