Overview
Our new Confluence-based Knowledge Base uses a combination of Confluence Spaces and a 3rd party plugin (Scroll Viewport by K15t) which renders these into Knowledge Base themed public facing URLs under our public site on scrollhelp.site.
It’s important to understand that our end-users / partners get links not to Confluence but to the rendered view that gets served up in our public-facing help site url (on scrollhelp.site). Confluence is the CMS, scrollhelp is the hosted output.
Changes by us get made in Confluence.
End-users see those changes after they are pushed live to our scrollhelp site.
List of Knowledge Bases
Our public Knowledge Bases content is drive from Confluence Spaces and rendered into a public view via our iot-help scrollhelp site. Each Confluence Space that we choose to share out gets a separate Knowledge Base URL that can be handed out to our end-users.
Here is a list of the public Knowledge Base Spaces that we have:
Space Name | Purpose | Language | Status / click for URL |
|---|---|---|---|
Customer Help | In-App Help | English | |
Customer Help (Francais) | In-App Help | French | NOT READY |
Partner Help | Partner & Console Help | English (no plans for localization) |
A Confluence Space will only appear to the public when it is added into our Scroll Viewport configuration. Thus the list above of LIVE sites is the complete list of publicly available Knowledge Base URLs that can be accessed by our partners/users.
Make changes in Article content
The following will help guide you on how to add or update content in our public facing knowledge bases.
Category Updates
Category updates must be made by Product team decision. At this time we ask that you bring any such requests to us - do not make any changes to categories or introduce new ones. Update articles only.
This applies to our Partner and In-App help systems.
Add, Edit Help Articles
Anyone is able to add or update help articles. We should all collaborate together to get this content in place.
Open the appropriate Space in Confluence (see List of Confluence Spaces).
Drill down in the list of Pages until you find the Category where your article will live.
💡 The display of Categories is the same when viewed in Confluence versus the public site.
Open the article for creation or edit
If you are editing an existing article, hover over it and select Edit (or you can do so after clicking on the page to view it).
If you are creating a new article, just click on the + sign in the category.
💡 You can always drag & drop the article to somewhere else if you make a mistake in where you create your article.
Use the WYSIWYG editor to create the article content.
💡 See below for some useful hints on article creation content using Confluence.When you have finished your changes use the Publish button. Your changes are saved as draft until then.
Your changes are saved but Remember that end-users will not see your changes until a new version of the public facing site is pushed live.
Confluence Article Tips
Here are some tips on creating / using Confluence for Help articles.
Most of these tips will be related to using the Insert to add a widget / control to help you with displaying content.
YouTube videos can be embedded using the Widget insert.
Youtube videos must start with https://www.youtube.com/watch?v= - if you paste in the embedded link version it won’t work.
Use the Children Display if you want your article to include a list of sub-pages appearing under it.
Update our Live Site
Confluence pages drive the content, but the K15t Scroll Viewport plugin is what renders our content to our live site.
Scroll Viewport takes whatever Spaces we manually set to include and when the content is generated it pushes those out as separate “apps” (separate Knowledge Bases), each of which can be access at the parent site or as sub-URLs that can be handed out.
Access Scroll Viewport
You can access the Scroll Viewport configuration in a couple of different ways - from the Apps option in Confluence or while viewing one of the pages.
Support for new Languages
todo