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.
Synapse Docs (Working Drafts) = For collecting edits and managing reviews on existing content. This is a
Synapse Docs = A hidden space where finished drafts from Working Draft space are sent to be queued for the production site. This site is hidden to avoid confusion about where to make edits.
Viewport Site = Production site
Changes made to a Confluence space will not go live on Viewport until an administrator triggers an update from a Viewport dashboard. This way, you can work on content behind the scenes and publish it to your public help center when it is ready.
Contributor workflow
Adding content in Confluence
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 the image from the article itself, as well as delete 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.
Naming conventions
If you are inserting a screen cap of the Synapse UI, name the file with a description of what image is showing, spaced with hyphens. For example, use report-violation-footer.png for an image of the Synapse footer showing where to find the link to report violations.
Changing image size
You can resize images within Confluence by dragging the edges of the image once you have embedded it on the page. However, these changes will not be reflected on the live Viewport site. To change the size of an image as it appears on the Viewport size, you must resize the image file itself. For more on resizing images see the Scroll Viewport help docs here.
Adding links to other articles or sections
To add a link to another Synapse docs page or section, go to http://help.synapse.org/docs and locate the article or section of interest. Copy the URL from that page, or copy the link next to a specific section heading. Paste this link into your Confluence page using the Confluence link editor ( 🔗 ) in the editing toolbar.
Adding downloads and attachments
To add a download link to a page (e.g. a pdf, template, or other file that users need to download), add your file as an attachment to the Confluence page. From the main page view (not the Confluence editor), click the three dots at the top right of the screen and select attachments from the dropdown:
Upload your files.
In the Attachments view, right click on the name of the attachments and select Copy Linked Address.
Go to your page and add a link to the desired text. Paste in the attachment link as the URL. Viewport will render the Confluence URL into a file download for external users.
Note: Viewport can only render links for items that are within the associated Confluence space. Items outside of that space (links or attachments from other spaces) will not render correctly on your Viewport site.
Macros
There are many macros available in the Confluence editor to style a page and add functionality to a Confluence space. The Scroll Viewport app can render some macros, but not all. Viewport also has many redundant features built in (e.g. automatically creating a table of contents for every article), so in many cases the use of additional Confluence macros on the page is unnecessary. In general, unless directed by a doc admin to use a macro, avoid using them in your articles.
Reviewing in Confluence
Comala Document Management is an app that allows you to add review/approval stages to Confluence pages and track status.
Making edits to a page will automatically move it to a Review stage. When you are finished with your edits to the page, publish your changes with a version comment (instructions here).