How do I create and edit handbook articles?

Learn how editors and administrators create, edit, link, and publish handbook articles.

Open a handbook in edit mode

Log in with your personal user account. Your account must have the editor or administrator role.

Go to the handbook you want to edit, and select the three-dot menu > Edit.

Note

If you cannot see the editing options, you may be logged in with the wrong user account or through a reader link. See Administrator cannot edit the handbook for complete troubleshooting instructions.

Open or create a handbook article

Select Content in the left menu. The handbook structure displays all folders and articles.

Select an existing article to edit it, or select Create > New article to create an article.

Edit a handbook article in the text editor

Use the text editor to add and format content. The text editor supports:

• Headings (H1, H2, and H3)
• Bulleted and numbered lists
• Images uploaded from your device or selected from Archive
• Tables, bold text, and italic text

Add an internal link to another handbook article

1. Select the text you want to link
2. Select the link icon in the toolbar
3. Navigate through the handbook content and select the article you want to link to
4. Select OK in the lower-right corner
5. Select Save

The link is added to the selected text.

Add a streaming video to a handbook article

1. Select the text you want to link to the video
2. Select the link icon in the toolbar
3. Paste the URL of the YouTube or Vimeo video

You can add a video to the handbook homepage in the same way.

To insert the video URL without selecting text, place the cursor where you want the link, select the link icon, and paste the URL.

Note

The handbook only supports streamed videos from YouTube or Vimeo. You cannot upload video files directly.

Save or publish a handbook article

When you finish editing, select one of the following options under Change type:

• New version – Draft: The article is not yet visible to readers
• New version – Activate: The article becomes visible to all users who have access
• Technical correction – Not a new version: Use this option for minor corrections that should not notify readers

Watch the handbook editing video

Watch the related training video