api-docs-icon

Deploying Documentation

Environments

Each documentation project will automatically be provisioned with a Preview and Production environment. Preview environments are authenticated and can only be accessed by users who are currently logged into Sideko and at minimum a Viewer role on the given project to view. See the Roles & Permissions section to learn more.

Triggering Deployments

When you are ready to deploy your documentation project, click the “Deploy” button in the right hand panel of the documentation editor.

trigger-deploy.png

When you are deploying to the Preview environment, you are able to continue editing the pages, links, and metadata of your documentation. However, when deploying to Production, your documentation content will be locked until a the deployment succeeds and you are provisioned a new documentation version.

Domains

During your first deployment you will automatically be provisioned a unique .sideko.dev domain for your documentation project. Custom domains are available for our Enterprise customers, contact us to learn more.