Project versions
  • 08 Oct 2021
  • 3 Minutes à lire
  • Contributeurs
  • Sombre
    Lumière
  • PDF

Project versions

  • Sombre
    Lumière
  • PDF

There is no French content available for this article, You are viewing the fallback version (English).

One of Document360’s flagship features is that you can have multiple versions of your project.

For example, if your project has a major upcoming release, and your documentation team needs to document all the new features, they can make a new project version that isn’t public that allows them to work on all the existing docs without changing the public version.

You can access the Project Version Manager by clicking on Settings → Knowledge base portal → Localization & versions → Localization & versions. The list of existing versions would be displayed.

1_Screenshot-Accessing_project_versions_in_portal


Pro tip
Making a version public doesn’t automatically show the articles it contains. In order for articles to show in a public version, they must be published.

Creating a new project version

2_Screenshot-Creating_new_project_versions_in_portal

  1. In Settings → Knowledge base portal → Localization & versions → Localization & versions

3_Screenshot-Creating_new_project_versions_in_portal_Blade

  1. Click New Version button at the top-right and a 'Add new version' blade would open

    a. Number of versions - You can view the number of versions used and the total number of versions permitted for your plan tier at the top of the Blade

    b. Name: Type in a name for the new project version

    c. Slug: The Slug URL (slug is the part that comes at the very end of a URL, and it refers to a specific page) would be auto-populated based on the version name entered above. However, this field can be edited. Keeping your slugs concise and descriptive makes for good SEO

    d. Version state: Choose the version state(s) (Main version, public, beta, eprecated). What each of the status means in briefed in the next section in this article

    e. Base version: You can either Start a fresh version or Select an existing version (The content of the base version will be copied to the new version). You can also pick and choose categiries in the base version that you require in the new version

    f. Language: If you have based the new version on an existing version, all the languages from the base version would also be added. However, you can add, hide, remove, or set as default using the language option

  2. Once you are done, click on the Add button and your new version would be added to your project

Depending on the size of your project, it may take a few seconds to add a new project version.

Project version states

The version state can be changed anytime after the version creation. Here's a drilldown into what each version state means and its purpose.

4_Screenshot-Version_selection_on_the_KB_site

  1. Main Version: If enabled, and there are multiple public versions, it will be the default version users land on when they visit your knowledge base.
Projects can only have one main version at a time.
  1. Beta: If enabled, a “Beta” tag will show next to the version name in the Documentation editor and knowledge base project version dropdowns. There can be multiple beta versions, as well as multiple public beta versions.
  2. Public: If enabled, the version will be available in the version selector in the knowledge base. Any version can be made public, even a deprecated or beta version.
  3. Deprecated: If enabled, a “Deprecated” tag will show next to the version name in the Documentation editor and knowledge base project version dropdowns. There can be multiple deprecated versions, as well as multiple public deprecated versions.

To change or apply a project version state

  1. Go to Settings → Knowledge base portal → Localization & versions → Localization & versions
  2. Click on the Edit icon on the version you want to update version state
  3. Select/deselect the state option you want to apply or change
    7_Screenshot-Update_version_state__in_the_Knowledge_base_portal

Deleting a Project Version

  1. Go to Settings → Knowledge base portal → Localization & versions → Localization & versions
  2. On the version you want to delete, click the Delete (Trash) Icon
  3. You cannot delete a main version

6_Screenshot-Deleting_versions_in_the_Knowledge_base_portal


Cet article a-t-il été utile?

What's Next