Versions Compared

Version Old Version 6 New Version 7
Changes made by

Brent Meriwether

Brent Meriwether

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Space Name

Purpose

Language

Status / click for URL

Customer Help

In-App Help

English

LIVE

Customer Help (Francais)

In-App Help

French

NOT READY

Partner Help

Partner & Console Help

English (no plans for localization)

LIVE

...

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.

...

Image Removed

Support for new Languages

todoImage Added

Pushing Live

As noted earlier, changes to Pages in confluence aren’t visible to the public until our live site is updated.

Note

We ask that at the moment you just notify Brent Meriwether to push changes live (or I would notice it when I check occasionally and do so for you). Once we get more comfortable with everyone using things, we can expand this to others pushing things live. For now, I’ll just document the process for visibility.

When you access Scroll Viewport, it will show you which spaces have a list of pending changes.

...

Going live is done by:

  1. Use the Update Site button from Scroll Viewport to start the Generate process.

    Image Added

  2. The Generate process will package up all the Space content and spit out a Preview of the changes.

    💡 This process will take several minutes.

  3. Once the Generate process is complete you will get a report and the ability to Preview your changes.

  4. If you are satisfied that everything looks good, you can use the Go Live button to push them public. This part is instantaneous.

Add support for a new Language

Currently K15t’s Scroll Viewport plugin does not support Localization within a single source. As a workaround, we have separate Spaces for each language.

See List of Knowledge Bases above for that list.

The process for adding support for a new Language is thus:

  1. Create a new Confluence Space.

    1. Give it a name such as “Customer Help (<Localized Language here>)”. This will help us to locate it easily in Confluence as well as to give it a nice display in the In-App help.

    2. When setting up the Space, you must a specific Key based on the language.
      It should be “IOTKB” followed by the 2-letter ISO standard for that language.
      e.g. IOTKBDE = German, IOTKBFR = French

      Image Added

  2. Localize the English content sources into your target language.

    1. You can either Copy the English source Pages into the new Space and have them manually update each article, OR

    2. You can give out a read-only link to our English sources / package it up as an export / whatever works best.

  3. When you are satisfied with the content you can add the Language to Scroll Viewport.

    1. Use Add new Content Source in the Scroll Viewport view.

      Image Added

    2. Point it at the Confluence Space that you set up for that language.

    3. You can then Generate a preview and push it Live once it’s good.

  4. The final step is to make it available in the Product. Currently this requires a new push of the PWA with a changed flag.

    1. Create a card for the Dev team to enable the Language + Language Flag for the chosen language in our dropdown.

    2. The dropdown assumes you will be using the 2-character ISO code for the language (e.g. iotkbde for German), but it probably wouldn’t hurt to link them to the full scroll help site URL just case.

Tip

Once the Scroll Help site is pushed and the language enabled in our app, you will see the language in the Help page dropdown as well.

...