Whenever you're ready to share it, you can publish your documentation. Publishing your documentation essentially builds a documentation site, and populates it with the content you've created in the editor. Any settings you've applied to your documentation will also be applied to your published documentation site (like privacy settings, for example).
Until then, you can preview your documentation. Like publishing, this essentially builds a preview site populated with your content, but it's completely private and secure, and won't make any changes your previously published documentation.
Preview your documentation
You can view content you've added or edited in your documentation on a preview site before you publish it. Previews can only be built for documentation in the current shared draft. Preview sites are password protected, so only logged-in viewers can access it if they're given the link.
To preview your documentation:
- In the top right corner of the documentation editor, click Preview.
- In the modal, click Build preview to build and open your documentation preview site.
Once you've built your first preview, you can click the Open page button in the modal to open the preview site.
You'll also now see information on when the preview site was last updated, and by whom.
Publish your documentation
Published documentation
When you're ready to share your documentation, you can publish it.
To publish your documentation:
- In the top right corner of the documentation editor, click Publish.
- In the modal, click Publish documentation to build and open your documentation preview site.
Once you've published your documentation, you can click the Open page button in the modal to open the preview site.
You'll also now see information on when the preview site was last updated, and by whom.
Managing documentation privacy settings
You can choose whether your published documentation site is public or private.
Public documentation sites can be accessed by anyone who has the link, without signing in.
Private sites require the viewer to be signed in to gain access to the documentation.
You can click on the Manage privacy settings button in the Publish modal to change the privacy settings for your documentation site.
Please note documentation needs to be published again for any new settings to be applied.