HOSTED SPACES

Version Links

4min
Document image
๏ปฟ

Version Links is a feature that allows you to create multiple saved versions of a Space.

Let's say you have a Developer Guide space, but soon enough, you release different versions of that product.

To keep the history and backward compatibility, you have to crate a new version to save the current content inย Developer Guide v1.0, and rename the default main version space to Developer Guide - Current Version or Developer Guide - v2.0 (depends how you preffer) and continue to update the content in this main version.

The same rule will apply when you want to create the next version. You have to save the current content in a new version in Developer Guide v2.0, and keep working in Developer Guide - Current Version or Developer Guide - v3.0 (depends how you preffer) for new updates.

The created versions should be onlyย clonesย of the default main version space you are trying to fork from.ย 

How to set up Version Links

1

Click on the gear icon โš™๏ธ for settings, then go to the Version Links tab under Space Connections section.

2

Enable the version link feature for that space (if you ar trying to save the first version).

Document image
๏ปฟ

โ„น๏ธ For public documentations

Make sure your documentation is Public and visible to everyone, before you start creating version links.

Document image
๏ปฟ
3

Select the space you want to clone from. You can select:

  • the main version - if you want to create a new version from the current main version;
  • or children (previous versions) - if you want to create an updated of an old version (if your last created version is v5.0 and you want to create v2.1, you have to select v2.0 as a starting point).

๐Ÿšจ Attention!

The main version space is where you should work on your content. It is the latest version of your space.

When you create a new version, you're essentially saving a snapshot of your current work. Any changes you make from this point should be on the main version.

4

Add a label for your new saved snapshot version.

For exemple, before you start updating the main version space to 'version 3' with the new content, you save a copy of the current version as 'version 2'. This will let you keep track of your changes and go back to the previous version if needed.

5

Select the space language. You can choose the following languages:

  • ๐Ÿ‡บ๐Ÿ‡ธ English
  • ๐Ÿ‡ซ๐Ÿ‡ท French
  • ๐Ÿ‡ฉ๐Ÿ‡ช German
  • ๐Ÿ‡ช๐Ÿ‡ธ Spanish
  • ๐Ÿ‡ฎ๐Ÿ‡น Italian
  • ๐Ÿ‡ต๐Ÿ‡น Portuquese
  • ๐Ÿ‡ท๐Ÿ‡บ Russian
  • ๐Ÿ‡ฐ๐Ÿ‡ท Korean
  • ๐Ÿ‡น๐Ÿ‡ญ Thai
  • ๐Ÿ‡จ๐Ÿ‡ณ Chinese
  • ๐Ÿ‡ฎ๐Ÿ‡ฉ Indonesian
6

Hit the "+ Create Version" button to create this new saved snapshot version.

Based on the above example, this created snapshot version will have the given name in Step 4 ("version2" in this case).

7

Repeat the steps from 3 to 6 until you add create your desired structure.

8

Exit the Space Settings window and publish the space, and they'll be propagated.

๐Ÿง  Remember!

You have to publish all versions in order to be visible on the public documentation.

Once you have created a new version, your spaces will be grouped in your Side Navigation and display the label you provided. This way, you will always be able to spot Spaces with multiple versions and find them in a single place.

Document image
๏ปฟ

Once published, you can see the changes in public spaces. The versions will be displayed based on the context. If the Space does contain a Space Link and also has multiple versions, it will be displayed in the Space Link Tab.

Once published you will be able to see the changes on public spaces. Here's how it looks for your readers:

Version Links view on Stripey template
Version Links view on Stripey template
๏ปฟ

Enable Auto-Translation of your spaces with Enable Auto-Translation with AI. Check full guide here: Enable Auto-Translation with AI๏ปฟ

๏ปฟ

๐Ÿค”
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.

๏ปฟ