Page drafts

Overview

The page drafts feature allows editors the flexibility to work on multiple documentation pages simultaneously and decide which pages to publish and when. This enhances collaboration and ensures fine-grained control over the content that goes live.

With page drafts, you can:

• Create and edit documentation pages as drafts.
• Select exactly which pages you want to publish.
• Easily discard edits and revert a page back to its published state.
• Publish or preview individual pages that have changes.
• Restore deleted page (before the next publish).

Creating a new page or editing an existing one automatically creates a draft. Drafts are clearly marked with a banner on the page and an edited page icon in the pages hierarchy.

---

When is a draft created?

A page draft is automatically created in the following scenarios:

• Page content is edited
• A page is created
• A group or page is renamed
• Layout or header changes are made to the page
• Any group, page or tab is made private / public
• Any group, page or tab is hidden or shown

---

Discard changes

To discard changes to a page:

1. In the Page status bar or in the navigation, click ••• to open the context menu.
2. Click Discard changes.
3. In the Discard changes dialog, type DISCARD to confirm.

The changes will be discarded and the page will revert to the last published state.

---

Preview documentation

View your draft changes on a preview site to see exactly how it will appear once published.

To preview your documentation site:

1. In the top right corner of the documentation editor, click Preview → Build preview.
2. In the Preview dialog, you will see a list of pages and groups that have changes.
3. Click Build preview.
4. Click the Open page button in the toast or modal to open the preview site.

Preview a single page

To preview a single page:

1. In the Page status bar, click Preview.
2. In the Preview dialog, the current page will be pre-selected.
3. Click Build preview.

The page will now be part of the preview site. Click Open preview to view it.

---

Publish documentation

To publish your documentation site:

1. In the top right corner of the documentation editor, click Publish → Publish documentation.
2. In the Publish dialog, you will see a list of pages and groups that have changes.
3. Click Publish documentation.
4. Click the Open page button in the toast or modal to open the published site.

---

Publish a single page

To publish a single page:

1. In the Page status bar, click Publish changes.
2. In the Publish dialog, the current page will be pre-selected.
3. Click Publish documentation to publish it.

Publish updates to design data

Updates made to design data will be updated automatically on all pages on the next publish. Deselect all pages and groups in the dialog to publish only changes to design data.

Publish updates to settings

Updates made to documentation settings will be updated automatically on the next publish.

---

Selective publishing

For those on a Team, Company, or Enterprise plan, you can selectively publish specific pages by using the checkbox list in the dialog. This feature lets you make only the desired changes immediately available.

To publish specific pages of your documentation site:

1. In the top right corner of the documentation editor, click Publish → Publish documentation.
2. In the Publish dialog, you will see a list of pages and groups that have changes.
3. Select which pages you would like to publish, and click Publish documentation.
4. Click the Open page button in the toast or modal to open the published site.

---

Delete a page, tab or group

When you delete a page, tab or group, it will be removed from navigation and it will appear in the publish dialog as Deleted.

When it is selected and published, it will then also be removed from the published documentation site.

---

Restore deleted pages

Deleted pages will be marked as ‘Deleted’ in the Publish dialog. From here, you can restore them. To do so:

1. Hover on the relevant page row in the Publish dialog.
2. Click the Restore button that appears on hover.
3. In the dialog, click Restore page to confirm.
4. The page will no longer be deleted once you publish your documentation.

FAQ