Breadcrumbs

Automatically Upgrade a Scroll Viewport site as a Scroll site

This page will outline the process to start and complete an automated replication of the site in Scroll Sites.

Start the Upgrade (Creates an Unpublished Copy of Your Site)

From the purple box in the My sites screen:

  1. In the list, look for the site you want to replicate and hover over it.

  2. Click Upgrade site.

  3. In the confirmation dialog, click Upgrade site again.
    Scroll Sites will now fetch all the files from your Viewport site and start building the site. Once the site is available, it will show in the My sites list in Scroll Sites.

  4. Find and click into your site from the My sites list or click Review site from the toast message that appears at the bottom of the screen. You will land in the Site settings screen for the site (which is still in unpublished state).

On top of the Site settings screen, you’ll see a purple Upgrade summary box. This box lists all the settings that couldn’t be copied over automatically. Before you can publish your site, you will need to adjust all the listed settings manually.

Use the Upgrade Summary To Adjust Remaining Settings Manually

Go through the items in the Upgrade summary box in the same order that they are listed in the box:

  1. Click the first item in the list. You will be scrolled down to the respective site settings.

  2. Open the setting and adjust it to reflect your Viewport site. Use the table below to help you make the adjustments.

  3. Scroll back to the Upgrade summary box and use the tickbox to check off the item you’ve adjusted.

  4. Repeat for all items in the list.

References on how to adjust individual site settings

Use the table below to help you make the manual adjustments required to complete the replication of your site in Scroll Sites.

Look and Feel

Some files couldn’t be collected from Scroll Viewport. Review your theme configuration and upload missing files.

To add missing files, navigate in Scroll Sites to Site settings > Look and feel > Customize theme.

Click through all of the tabs in the left hand side and identify any Upload file fields that are empty and upload the respective files.

Redirects

To quickly migrate all your existing redirects from Viewport, navigate in Scroll Sites to Site settings >Redirects > Advanced Redirects and copy paste all your redirects from Viewport into the editor.

Custom CSS

Review your injected CSS code and possibly adjust some of the tokens, HTML attributes, components etc.

Custom JS

Review your injected Javascript code and possibly adjust some of it.

To identify which parts of your custom code need to be re-written, please refer to https://k15t.jira.com/wiki/spaces/STS/pages/15155200045

Add your AI integration credentials to enable AI Search.

To add your OpenAI API key, go to https://platform.openai.com/api-keys and copy paste the same key you used in your Viewport site into the OpenAI API key field under Site settings > AI.


Make sure to complete all other site settings (except for site access) before you set up the right domain for your site.

Site URL

Switch your domain from the temporary one to the (custom) domain you used in Viewport.

Does your Viewport site use a scrollhelp.site domain?

Simply navigate in Scroll Sites to Site settings > Site URL and under Use provided domain, in the Site domain field enter your used subdomain. From the dropdown, make sure to select .scrollhelp.site as the provided domain.

We will automatically disconnect your existing Viewport site from the entered domain.

Does your Viewport site use a Custom domain?

To connect your new site to the same customdomain that your Viewport site is using, follow the steps on https://k15t.jira.com/wiki/spaces/VPRTDOC/pages/14492139521 .

Site access

Review and apply your existing access settings to protect your site the way you want.

Make sure to set up your custom domain before you set up protected site access.

To set up a login protection with tokens or single sign-on, follow the steps on https://k15t.jira.com/wiki/spaces/STS/pages/14939815951 .

Complete the Upgrade (Go Live With Your New Site)

Once you have checked off all the items in the Upgrade summary box, you can save and bring all changes to the live site. We recommend to review your unpublished site one more time, then go live:

  1. In the Upgrade summary box, click Complete upgrade. This will remove the box and resolve all ‘review’ statuses in your site settings.

  2. From the top of the Site settings screen, click Save changes.

  3. From the left sidebar, click Site updates.

  4. In the top right of the Site updates screen, click Publish updates. This will bring all settings adjustments you made to your unpublished site.

  5. From the sidebar, click View site. This will open your unpublished site in a new tab.

  6. Thoroughly navigate through your site to make sure that your site looks and behaves exactly as your existing Viewport site. For example, you might want to test out some redirects or any enabled integrations, if your site uses them, or check that the styling and branding looks as expected,
    Please note that the help center theme in Scroll Sites is not identical to the one in Scroll Viewport.

Differences between Scroll Viewport’s and Scroll Sites' Help Center theme

  • 🎨 Visual changes. There are some small visual differences between the Help Center theme in Scroll Sites and the one in Scroll Viewport that are expected. Visual tweaks include font sizes, size of components, images etc.

  • 📏 Banner images are centered. The banner image in Scroll Sites' help center theme is centered (both vertically and horizontally) while the one in Scroll Viewport is aligned to the top. We recommend you review and adjust your banner image file as needed.

  • 🗑️ Removed icons from the portal and content source pages. The small material icons were removed from Scroll Sites' help center theme due to technical reasons. An improved solution will be coming.

  • 📑 TOC now considers H2 to H6. The table of contents in Scroll Viewport’s help center theme only showed heading levels 2 to 4. Scroll Sites' help center theme will include headings up to level 6.

  • ❌ No support for legacy pages. While Scroll Viewport never officially supported pages created with the legacy editor, some of its content still rendered in acceptable ways. Since Confluence is deprecating the legacy editor soon, Scroll Sites is no longer rendering its content correctly. We recommend to auto-convert all your pages to the new editor. Read more on Convert pages to the cloud editor.

  1. Close the site and go back to the Scroll Sites app.

  2. From the sidebar, click Go live.

By default, your replicated Scroll site’s update strategy will be set to Manual updates to mirror the behavior of your Viewport site as closely as possible (content changes are published on demand through the click of a button).

In Scroll Sites you now have the additional option to opt for Live updates instead. If you’d like your content changes to reflect almost instantly in your site (requiring no additional action on your part), we recommend to check out this new option from Site settings > Update strategy.

Done with your upgrade?

It’s now time to proceed and delete the original Viewport site.