| Table of Contents | ||||
|---|---|---|---|---|
|
Overview: How does the Synapse Docs website work?
...
To flag an issue or request a change to Synapse Docs, follow these steps:
Open a Jira ticket in at link it to the Synapse Docs project. Specify the doc location, describe the issue, and suggest a fix.
Leave the ticket unassigned if you want the ticket triaged and managed for you.
Assign the ticket to yourself if you want to make the fix. Find the relevant page in the Synapse Docs (Working Drafts) space and edit the page by clicking the pencil icon (
). Publish your changes to the page with a version comment describing your updates. When you are done, click the Review button at the top of the page and assign an administrator (Stacey or Ryan), who will review and approve your changes and then push them to the live docs site.
...
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.
...