Write and publish a website guide

Website guides are written through the app's Docs area. They are different from internal team documents. Only use this workflow when your organization intends to publish information on its public documentation site.

Before you start#

• Ask your administrator whether Website docs is enabled for the workspace and whether the host is configured to serve public docs.
• Confirm that you can write in the website guide area and select an eligible reviewer.
• Prepare content intended for internet readers. Internal company visibility is not approval for internet publication.

If Docs is absent, ask the administrator to check its availability and your access. Do not move private material or change its classification simply to make it appear publicly.

Write and request review#

1. Open Docs from Utilities in the app. On a phone, check the profile menu for the available utilities.
2. Select New doc, choose the intended website category, then select Start writing.
3. Give the guide a task-focused title. Add useful tags and write the content.
4. Include the audience, prerequisites, exact steps, expected result and common problems. Use headings to distinguish procedures from explanation.
5. Select Save and confirm that the save succeeds.
6. Select Submit for review from the document actions, then choose an eligible reviewer.
7. Check the review result. If changes are requested, revise the content and submit again.

Saving keeps the work in the editor; it does not establish that the website has published it.

What makes a guide eligible for publication#

All applicable conditions must hold:

An administrator can investigate these conditions. Changing a live website guide sends the revised content through the required review process.

Verify the public result#

After approval, open the public documentation site signed out, find the guide in its category and check its title, body, links and images. If it is absent, ask the administrator to investigate publication eligibility and host configuration.

A missing or disabled catalog does not mean that ordinary built-in guides are unavailable. Do not repeatedly approve the same document to resolve a configuration issue.

Internal Documents are different#

Inside the app, Public visibility means the company audience, not everyone on the internet. Review Document approval for internal collaboration and the platform model for audience distinctions.