Versions Compared

Key

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

...

  • Specify the location: Provide a link to the relevant article or section where you want the change made.

  • Describe the problem or change: Write a detailed description of what is wrong or what needs to change. Screen caps are helpful.

  • Suggest a fix: Propose a solution or describe how the issue should be addressed. If you are proposing a new topic (such as a new feature), include links to internal docs with information about that topic/feature (user stories, feature requirements, etc). The more detail you can provide, the faster your issue will be triaged.

If you would like the issue to be triaged and managed for you, leave the Assignee field as Unassigned. Note that you may still be asked to contribute to the fix if you are a subject matter expert.

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

Contribute directly in Confluence

Depending on the nature of your Jira ticket, you may be tagged 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 (or you may be tagged in the article).

  • 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.

...

Doc review 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.

...

If additional changes are needed, you will work with your reviewers to address any remaining issues and then repeat the approval request process.

Doc approval in Confluence

If you have been selected as a reviewer by someone else, you will receive an email notification that your review has been requested in Confluence. Follow the link in the email to view the Confluence page.

Review the document. If you have comments, highlight the relevant text and select Comment from the pop-up window.

...

If you make edits to the document as part of your review (e.g. you enter the Confluence editor and change the text), the approval workflow will automatically revert back to a draft state, canceling the approval process, and you or someone else will have to re-request approval to move your document forward.

Confluence How To’s

Inserting and removing images

...