Skip to end of banner
Go to start of banner

Synapse Docs Contributor Guide

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview: How it works

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.

Here is a schematic of how Confluence and Viewport are configured to publish the Synapse Docs website:

  1. All drafts are edited, reviewed, and approved in a Confluence draft space, called “Synapse Docs (Working Drafts)”. You are currently reading this doc from within this draft space.

  2. Once an article has been edited, reviewed, and approved, an admin syncs the final draft to a second Confluence space for final drafts.

  3. This final draft space contains only the finished versions of every article in the Synapse Docs library. This space is hidden from most contributors 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.

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

Contributor workflow

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 description, you must include:

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

Contribute directly in Confluence

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

Review and approval in Confluence

Making edits to a page in the draft space will automatically assign a “Review” status to that page, indicating that

  • No labels