How To Upgrade To Scroll Sites
Scroll Sites is the next generation of Scroll Viewport. This new app will eventually replace Scroll Viewport. We recommend that you take your existing Scroll Viewport sites to Scroll Sites as soon as you can, in order to benefit from the new features and improvements.
Learn more about Scroll Sites on How Does the Launch of 'Scroll Sites' Affect Me as a Viewport Cloud User?
To upgrade to the new Scroll Sites experience, start by creating a new site in Scroll Sites. This site will replace your old site in Scroll Viewport.
1. Create a New Scroll Site
To create a new site in Scroll Sites:
In Confluence, open Apps > Scroll Sites.
Follow the steps on Create a Site. In the site creation wizard, make sure to:
For the theme, select Help Center.
For the URL, set any URL. You will connect your custom domain later, or, if you use one of our provided domains, you can later set up redirects from example.scrollhelp.site to example.scroll.site. or example.scroll-sites.com
For the site visibility, select Unpublished.
For the content, add at least one space or Scroll Document from your existing Viewport site. You can add more content when you change the site settings in the next step.
Once you have created your site, you will need to adjust the site’s settings to reflect those in your Scroll Viewport site.
2. Adjust the Site Settings
Once your Scroll site is created, you will land in the site’s settings. To adjust the settings:
Go to Site settings > Content and add all your remaining content from the existing Viewport site. In the process, make to sure:
Adjust the URL path for each content source to reflect the URL in your Viewport site.
For Scroll Documents: select which version, variant, and language should be added to the site and, optionally, customize the URL path for each to reflect the values in the Viewport site.
Under Site settings, compare all your settings to your Viewport site’s settings.
Skip the custom domain and site access settings for now. Adjusting those settings need to be the last step in your migration.
To quickly migrate all your existing redirects from Viewport, click Advanced redirects in Scroll Sites' site settings and copy paste all your redirects from Viewport into the editor.
You will need to adjust all your redirects of the type fallback
to regex
.
2. Adjust the Look and Feel
To bring the same styling and branding from your Viewport site to your Scroll Site:
Open Scroll Sites and go to Site settings > Look and feel > Customize theme.
Open Scroll Viewport in a new browser tab and go to Edit theme > Templates.
Replicate the settings from Scroll Viewport’s theme editor in Scroll Site’s theme configurator. You can use the preview to see how the changes apply.
Click Save changes in Scroll Site’s theme configurator.
Click Close to exit Scroll Site’s theme configurator.
Wait for the update to conclude (see Site updates screen), then click View site from the left sidebar.
In your unpublished site, check that the styling and branding looks as expected. Please note that the help center theme on 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.
🎚️ Custom code might require adjustments. Depending on the tokens, HTML attributes, components etc. you’ve used in your custom code, you might need to inspect your site and re-write your custom CSS or Javascript. Please refer to Migrate Custom Code From Scroll Viewport to Scroll Sites for all details.
3. Optional: Connect your Custom Domain and Set Up A Login
If your old site used a custom domain, connect the domain to the new site before you set up a login protection.
To connect your new site to the same custom domain that your Viewport site is using, follow the steps on How To Move a Custom Domain From One Viewport Site to Another Site .
To set up a login protection with tokens or single sign-on, follow the steps on Protect Access To a Site .
Legacy URLs in the formats /page-title.12345678.html
are no longer supported. If you still actively use links in this format, you should set up redirects in Scroll Sites.
4. Bring Your New Site Live
Once you are happy with the site you’ve built, replace your old Scroll Viewport site with a live Scroll site:
In Scroll Sites, go to Site settings > General.
Under Site visibility, click Go live.
From the left sidebar, click View site and check that everything in your new site is working as expected.
In Scroll Viewport, open the site details screen and click ••• → Delete site → Take offline → Delete.
Your old site is now deleted and replaced with your new Scroll site.
From now on, manage and maintain your site using Scroll Sites.