| 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.
Here Below is a schematic of describing how Confluence and Viewport are configured to publish the Synapse Docs website:
...
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
...
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 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.
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.
File an issue in Jira
Go to the Docs project in Jira and open a new ticket. In the In the ticket description, you must include:
...
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 (or you may be tagged in the article).
Switch to edit mode by clicking the pencil icon (
) 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 (
) 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.
...
Add Stacey Taylor a Synapse doc admin (required) and anyone else who you want to review and give approval for should review the content (optional) and approve the doc.
...
If additional changes are needed, you will work with your reviewers to address any remaining issues and then repeat the approval request process.
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.If additional changes are needed, you will work with your reviewers to address any remaining issues and then repeat the approval request process.
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.
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.
...
If you or anyone else makes edits to the document after requesting approval (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.
Special Cases
Deleting Content & Redirecting
Once a page is deleted in Confluence, its URL is no longer valid. You won’t be able to redirect from deleted content. To work around this, leave the existing page as an interstitial page and include a link to the new content as such (suggested text):
“This is not the content you’re looking for. The content you want is over here <link to new content here>.”
Confluence How To’s
Inserting and removing images
Use the editing toolbar in Confluence to insert images into your articles. Confluence will automatically add each image as an attachment to the page in addition to embedding the image in the article.
To remove an image, you must delete click on the image and use the trash can icon to remove the image from the article itself, as well as delete . Doing so will also remove it from the page attachments list. From the main page of an article (not in editing mode), click the three dots in the upper right () and select Attachments. Delete the images you no longer need.
Image naming conventions
...