Versions Compared

Key

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

...

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 This page is for anyone who wants to flag an issue or contribute edits to Synapse Docs.

Below is a schematic of describing 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

...

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.

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

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.

...

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.

...