| Table of Contents |
|---|
Overview: How
...
does the Synapse Docs website work?
Scroll Viewport is a Confluence App that allows you to quickly publish Confluence pages in a styled Help website. You write and edit your content in Confluence, structure individual pages into a page tree hierarchy, and then push content to Viewport. Viewport builds a static site from one or more Confluence spaces, preserving your page tree hierarchy as the site architecture. This page is for anyone who wants to flag an issue or contribute edits to Synapse Docs.
...
All drafts are edited, reviewed, and approved in a Confluence space for working drafts, called “Synapse Docs (Working Drafts)”. Think of this space as a kind of staging area for all Synapse Docs content. You are currently reading this doc from within this draft space.
Once an article has been edited, reviewed, and approved, an admin syncs the final draft to a second Confluence space for final drafts.
This final draft space contains only the finished versions of every article in the Synapse Docs library. This Confluence space is hidden from most contributors to everyone except administrators to avoid confusion; keeping all working drafts in one space and all final drafts in another allows us to separate what is ready to publish and what is not.
Content in the final draft space is built into a user-facing help website using the Viewport app. When an admin triggers a new build, Viewport pulls all content from the final draft space and creates a static site.
...
How do I contribute?
To flag an issue or request a change to Synapse Docs, follow these steps:
Open a Jira ticket in 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.
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.
...