Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

The migration tool is only available to Confluence administrators.

It’s not possible to migrate blog sites, because this type of site doesn’t exist on Cloud. Create a new site on Cloud instead, add the Confluence Space(s) containing your blog posts to the site, and use the News module to show blog posts

Step 1. Prepare for migrating your Refined macros

The Refined Sites for Confluence Cloud app doesn’t come bundled with Refined macros like the Server/DC app does. This is due to the technical differences between Confluence Server/DC and Confluence Cloud. Macros are instead available in our app Refined Toolkit for Confluence Cloud.

This means that you if you use Refined Sites macros on Server/DC, you need to install Refined Toolkit on your Cloud instance. If you don’t, the migrated macros will show as Unknown macro on your Cloud pages. Depending on which macros you use, you may need to take additional steps or apply workarounds to secure that your macros will work as intended. How this preparation looks depends on your specific setup. The following guide helps you assess how to proceed in your situation.

Step 1a. Check if you’re using any Refined Sites macros

  1. Go to General Configuration.

  2. In the left-hand menu, find the Administration heading and click Macro usage.

  3. Do you see macros listed for the apps Refined Sites for Confluence and Refined Toolkit for Confluence?

    1. No > You aren’t using Refined Sites macros, so you can move on to step 5 of this preparation guide.

    2. Yes > Follow steps 4b-4d.

Step 1b. Note down which Refined Sites macros you use

The macros are named according to their macro keys, which in most cases are self-explanatory. There are however some exceptions, in which macro keys can have two different names:

Macro

Macro key

Activity Stream

rw-activity-stream

recently-updated-dashboard-category

Divbox

rw-divbox 

divbox.

Space News

rw-space-news

space-news

Spaces

rw-spaces-in-categories

spaces-in-category

Step 1c. See which actions to take for each Refined Sites macro

Consult the tables below to see what will happen to your macros after migration and decide which actions to take. In most cases you can prevent issues by installing our app Refined Toolkit for Confluence Cloud. Note that macros on Cloud might look and work a bit differently - click the links to read the documentation.

This table shows which Refined for Confluence Server/DC macros you can keep using if you get Refined Toolkit on Cloud.

Refined Sites for Confluence Server/DC

Refined Toolkit for
Confluence Cloud

Activity Stream

Activity Stream

  • Supported settings: Title, Max items (limit), Types, Authors, Labels (label), Spaces (space key)

  • Unsupported settings: Content Types, Authors, Category key, CQL

Content Layout

Layout Editor

(warning) This macro is available on Cloud, but it is not migrated from Server/DC to Cloud. This means that you have to recreate it on Cloud.

Page Tree

Page Tree

(warning) This macro is available on Cloud, but it is not migrated from Server/DC to Cloud. This means that you have to re-add it on Cloud.

News

News

  • Supported settings: Title, Theme (DisplayMode), Max items (limit), ProfilePic, ShowSpaceName, Labels (label), Spaces, CQL

  • Unsupported settings: Type, Profile pictures, Categories, Show space name, View in popup, Expand first item

This table shows which Refined Toolkit for Confluence Server/DC macros you can keep using if you get Refined Toolkit on Cloud.

Refined Toolkit for Confluence Server/DC

Refined Toolkit for
Confluence Cloud

UI Button

Button

  • Supported settings: Title, URL, Tooltip, Size, and Color.

  • Unsupported settings: Icon, Display, Open in a new window

  • It’s not possible to set custom color profiles on Cloud.

  • URLs are static. If they link to local pages and blog posts in Server/DC, you need to manually change the link to the new URL in Cloud.

UI Children

Child Pages

  • Supported setting: Page

  • Unsupported settings: Display, Columns, Sort children by, Reverse sort

UI Children Cards

Turns into a Child Pages macro with the cards display mode.

UI Expand(s)

Expand (Container)

  • Supports the same settings as on Server/DC

UI Image

  • Images are migrated if you have Refined Toolkit Cloud, but they are not editable. To add images in Cloud, simply insert them in the Confluence Editor.

UI Step(s)

Step (Container)

  • Unsupported setting: Size

UI Tab(s)

Tab (Container)

  • Supports the same settings as on Server/DC

UI Text Box

Panel

  • Supported setting: Type

  • Unsupported settings: Text size, Show icon

  • It’s not possible to set custom color profiles on Cloud.

This table shows Refined for Confluence Server/DC macros that aren’t supported in Cloud – neither by Refined Sites nor by Refined Toolkit. Where applicable, we suggest workarounds for your setup.

Refined for Confluence Server/DC

Workaround for Cloud

Divbox

Although the Divbox macro doesn’t exist on Cloud, images and text within the Divbox macro are migrated if you have Refined Toolkit. Macros in the Divbox are not rendered due to technical limitations – read more about this in step 4d below.

Favorite Pages

Users can save Confluence pages on your Refined site for future reference, by clicking the Star icon in the top-right corner of a page. By clicking My favorite pages in the avatar menu, users see an overview of all pages they saved.

My Work

After you migrated to cloud, create a Layout Editor macro and place an Activity Stream macro in it. Set up the Activity Stream macro with CQL: type=page AND contributor = currentUser()

Note that this solution will only work in native Confluence, because Refined sites can’t show Layout Editor macros.

Search

Use Confluence’s Livesearch macro.

Space News

Use Refined Toolkit’s News macro instead.

Create Space Button

Spaces

User Details

User Network

Users

Users in Category

Users in Space

Due to differences between Server/DC and Cloud, these macros become irrelevant after migration. That’s why they aren’t supported and don’t have a workaround.

To make sure that your macros work as expected, we recommend to install Refined Toolkit for Confluence Cloud before migrating.

Step 1d. Un-nest macros to prepare for the new Confluence editor

When you migrate to Cloud, you edit your pages in Confluence Cloud’s legacy editor. This editor is similar to the one you're used to from Server/DC. While Atlassian recommends you to convert your pages to the new editor, this may pose problems with some of your migrated macros.

On Server/DC it is possible to nest macros which contain content within one another. These are called bodied macros. This is essential to the functioning of some macros: for example, you place content in a Step macro within a Step Container macro.

Due to a Confluence Cloud limitation, it is not possible to nest bodied macros in the new editor on Cloud. So when you convert a page with a nested bodied macro from the legacy editor to the new editor, the macro becomes uneditable.

To prevent this, we recommend un-nesting bodied macro content before migrating:

  1. Go to General Configuration.

  2. In the left-hand menu, find the Administration heading and click Macro usage.

  3. In the overview, look for the apps Refined Sites for Confluence and Refined Toolkit for Confluence.

  4. Click these macros to see on which pages they are located:

    • Expand Container (contains Expand macros, which contain bodied content)

    • Tab Container (contains Tab macros, which contain bodied content)

    • Step Container (contains Step macros, which contain bodied content)

  5. Take out the content out of each macro and paste it directly on the page. You can re-create the setup after migration, using the Cloud equivalents of these macros.

If you have many nested macros, it’s understandable that you might not have the time to un-nest them all before your migration. In that case, a temporary solution is to migrate as-is, stay in the legacy editor at first, and gradually convert pages to the new editor as needed:

  1. On the published page, copy the content from the macros.

  2. Go into editing mode and convert the page to the new editor.

  3. In the new editor, paste the content back in where the macro used to be.

We're aware that neither option is ideal, and we're in contact with Atlassian to solve this. Note that we do recommend you to move to the new editor over time, despite the hassle of manual work. Although migrated macros usually show on the legacy editor pages at first (if you have Refined Toolkit installed), they may still break eventually if Atlassian makes changes to the legacy editor.

If this issues affects you, please vote or comment on this ticket.

Step 2. Migrate your Confluence instance

Use Atlassian’s Confluence Cloud Migration Assistant to migrate your Confluence Server/DC instance to Cloud.

Step 3. Install Refined apps on Cloud

Install these apps on your Atlassian Cloud instance:

App

Description

Refined Sites for Confluence Cloud
Required

Required app.

Refined Toolkit for Confluence Cloud
Optional

Install if you assessed during preparation that you need it to keep using your macros on Cloud.

Refined Sites for Jira Service Management Cloud
Optional

Install if you want to integrate service desks into your Cloud sites.

Step 4. Upgrade Refined for Confluence Server/DC

Upgrade Refined for Confluence Server/DC to the latest available version. How to upgrade depends on which version you currently use. To check your current version, go to the Confluence AdministrationManage apps.

Your current version

How to upgrade

Version 1.0.0 - 5.1.19

  1. Install version 6.1.21 from Atlassian Marketplace.

  2. Navigate to Refined Administration and click the Upgrade button.

  3. Follow the steps below (for version 6.0.0 - 7.0.x).

Version 6.0.0 - 7.0.x

  1. Go to the Confluence AdministrationManage apps.

  2. Install the latest version of Refined for Confluence.

  3. Make sure Refined is compatible with your Confluence instance.

  4. Make sure that your Confluence instance is fully backed up.

  5. Go to the Confluence Administration > Refined > Configuration.

  6. Click the Upgrade the theme data to Refined 7.1.x data button.

  7. When you have upgraded Refined Sites for Confluence, advise your users to refresh their browser. Stylesheets and scripts have changed in new versions and need to be reloaded. 

Version 7.1.x or newer

  1. Go to the Confluence AdministrationManage apps.

  2. Install the latest version of Refined for Confluence.

Step 5. Export a site with the migration assistant

  1. Go to the Refined Administration.

  2. Go to the Site Builder tab.

  3. Toggle on Cloud migration mode and click a site’s Cloud button.

  4. Follow the steps in the dialog that opens.

Step 6. Import and set up the site on Cloud

  1. Go to your Atlassian instance.

  2. Click Apps > Refined in the navigation menu.

  3. Click the Open Refined button.

  4. Click the Import Server or Data Center site button.

    image-20240626-144940.png

  5. Decide what we should call your site in the Refined Administration. This name also shows up in the browser tab for your site’s visitors. 

  6. Choose your site’s URL by picking a subdomain: (subdomain).refined.site. While you are welcome to keep this URL, you can also set up a custom domain later.

  7. Let us know what kind of site you’re importing.

  8. Upload the file you exported from your Server or Data Center instance. Keep the tab open while the file is uploading.

    image-20240626-144946.png

     

  9. Click the Continue button. It may take up to 2 hours to create your site. You can close the tab and check back later.

    image-20240626-144950.png

     

  10. Review your site once it’s ready. You may need to make changes in your setup, depending on your configurations and assessments you made on Server/DC.

Possibility to migrate only single layouts

To get more granular control over the modules, you can always migrate layouts individually, outside of the migration assistant. You can then import these layouts on Cloud, where they are called landing pages.

To migrate a single layout:

  1. Make sure you have the following installed:

    • Refined Sites for Confluence Server/DC version 7.4 or newer (if you need to upgrade, see the version 7.4 upgrade instructions).

    • Confluence Server/DC version 7.15 or newer.

  2. On your Refined site, go to a site or category home and click the … Three dots in the top right corner > Edit site/category home.

  3. Click the Import/Export button > Download latest published version for use on Cloud.

    image-20240626-144958.png

     

  4. If the layout contains modules that are unavailable on Cloud, a popup will appear. Select if you want to exclude or replace these modules in the Cloud layout. Scroll down for a module comparison.

  5. When you're ready, click Download.

    image-20240626-145005.png

     

  6. Go to the landing page on your Refined Cloud site where you want to use the layout.

  7. Click the … (three dots) > Edit page to open the Page Builder.

  8. Click the Three lines in the top-left > Export/Import page layout.

  9. Upload the layout.

  10. Make adjustments if necessary and hit Publish.

Module comparison

Because of technical differences between Cloud and Server/DC, there are some differences between the modules in the Layout Editor (on Server/DC) and the Page Builder (on Cloud). If the layout you export contains modules that are unavailable on Cloud, you can configure how they should be handled in the export.

Layout Editor modules
Server/DC

Page Builder modules
Cloud

Activity Stream

Activity Stream

Confluence Content

There is no alternative for this module on Cloud, so it won’t be included in the downloaded layout. If you plan to add another module in its place on Cloud, a placeholder can help you see where the module used to be.

HTML

HTML

My Work

Replace the module with an Activity Stream module in the layout that you download, or exclude it altogether.

The Activity Stream module is set up with CQL to show the activity of the current user: type=page AND contributor = currentUser()

Navigation Cards

Card

Navigation Image

Image

Navigation Icon

Icon

Navigation Content

This module is automatically replaced with an Image module with the Navigation Content style.

Navigation Highlight

This module is automatically replaced with an Image module with the Navigation Highlight style.

News

News

Pages

Pages

Search

Search Highlight

Spaces

Replace the module with a Site Navigation module in the layout that you download, or exclude it altogether. The Site Navigation module automatically shows the landing page’s child spaces.

To show only specific spaces, exclude the module from the export and add them manually in a Links module as individual items.

User Details

Users in Category

Users

There is no alternative for these modules on Cloud, so they won’t be included in the downloaded layout. If you plan to add another module instead on Cloud, a placeholder can help you see where the module used to be.

Create similar user overviews manually with Image and Text modules.

Once you’ve migrated the layouts, you can also start using these modules:

Section permissions limitation

The permission settings Anonymous, Anyone, and Logged in users only (without user groups specified) are migrated. The setting Logged in users only (with user groups specified) isn’t migrated and needs to be set up manually on Cloud.

Step 7. Re-create and apply themes

Themes aren’t migrated and need to be re-created manually using the Theme Editor.

https://www.youtube.com/watch?v=MWJfia6MXVQ

What’s next?

Why not transform your Confluence instance into even more sites users love — you can create an unlimited amount of sites with your Refined Sites for Cloud subscription:

Need more help?

Have a look at the FAQ and the Videos, demos & other resources page.

And of course don’t hesitate to contact us:

  • Migration assistance. Our support team is always there to help you with questions before, during or after migration.

  • Migration assessment. In a one-on-one meeting, we give personalized advice on how to move and improve your sites.

  • No labels