Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Versions and DOIs

Drafts and versions

Each publication is a series of versions. You edit a version as a draft, and it becomes public when you publish it. To change a published publication, publish a new version. Every change, even a typo fix, is published as a new version.

Start a new version

Open the publication and click Edit in its header. This opens a draft of the next version, with the content and details of the current one. If a draft of the next version already exists, Edit opens that draft instead.

The header of a released publication, with an Edit button next to its Result tag.

Figure 1:Click Edit to start a new version.

Make your changes on the draft. Changes to both the content and the details ship with the next version.

A new version needs a version description that says what changed and why. Readers see it in the version history.

The Version description section of the draft, with the text "Corrected the growth rate units in Figure 2."

Figure 2:Describe what changed in the Version description section.

When you are ready, click Release new version… at the bottom of the draft.

The Release a new version? bar, with Save draft and Release new version buttons.

Figure 3:Click Release new version… when you are ready.

The version description is filled in as the release note. Confirm that all byline authors have consented to the release, and click Release new version.

The release dialog for a new version, with the consent checkbox ticked and the release note filled in.

Figure 4:Confirm that the byline authors consent, then release the new version.

The slug and license of a publication can’t change after its first release, and neither can its concept DOI. Releasing a new version makes its version DOI permanent.

How DOIs work

If your organization has DOI minting turned on, each publication gets two kinds of DOI:

DOIs are reserved as drafts while you work, and become public when you publish.