Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For more detail and step-by-step instructions with screen caps for each of these steps, see the sections below.

...

File an issue in Jira

To flag an issue or contribute directly to the docs, create a Jira ticket in the Docs Project. Your ticket will be triaged depending on the nature of the issue. For larger projects like major re-writes or new articles, you will be tagged to contribute directly in Confluence.

...

If you would like to make the changes yourself, assign the ticket to yourself and follow the instructions below to contribute directly in Confluence.

Edit directly in Confluence

Depending on the nature of your Jira ticket, you may be assigned to contribute directly to the docs in Confluence.

  • Go to the Synapse Docs (Working Drafts) space and locate the article you want to update.

  • Switch to edit mode by clicking the pencil icon ((blue star)) in the upper right toolbar.

  • Make your edits. Refer to the Style Guide and the How To sections below for help with how to write content.

  • To save your edits, click the three dots ((blue star)) in the upper right toolbar and select Publish with version comment. In the resulting pop-up, add a description of what you changed and click Publish. Note this action does not make your content publicly viewable yet, it is only viewable internally on Confluence.

Requesting approval in Confluence

When you are ready for your content to be approved and sent to the Viewport site, click the Review button at the top of the page, then select +Add Reviewer.

...

Once approved, your doc will be synced with the final draft space by a space admin. Your changes will be incorporated with the next build of the doc site.

Granting doc approval in Confluence

All edits to Synapse docs require approval from an admin, however you may be selected as an additional reviewer if you are a subject matter expert on the topic in question.

...