Custom Documentation

NoteDocumentation for Posit Connect Administrators

The information on this page is for Connect users with the Administrator role.

Overview

Users with the Administrator role can add optional custom content on the Documentation page of Posit Connect. This feature is useful for adding organization-specific documentation or links to external resources that Connect users frequently visit.

Users with the Administrator, Publisher, and Viewer roles can view custom documentation.

Note

Connect server administrators can block Viewers from seeing the Documentation page, including custom documentation, by setting HideViewerDocumentation to true. For more information on this setting, see the Configuration Appendix of the Connect Admin Guide.

Custom documentation uses Markdown formatting. For information on basic Markdown syntax, see the commonmark.org documentation.

Adding custom documentation

If you are a Connect Administrator, you can add custom documentation by following these steps:

1. Click Documentation in the Connect top navbar.

2. Below the grid of Posit-provided documentation cards, click + Add Custom Documentation.

   

3. Enter the documentation you want to include and check the Preview, if desired.

4. Click Publish.

   

Editing custom documentation

If you are a Connect Administrator, you can edit custom documentation by following these steps:

1. Click Documentation in the Connect top navbar.

2. Below the grid of Posit-provided documentation cards, click Edit above the existing custom documentation.

   

3. Make your changes and check the Preview, if desired.

4. Click Publish.

   

Removing custom documentation

If you are a Connect Administrator, you can remove custom documentation by following these steps:

1. Click Documentation in the Connect top navbar.

2. Below the grid of Posit-provided documentation cards, click Edit above the existing custom documentation.

   

3. Click Delete below the text field, and then Delete in the dialog that appears.