We’re not asking why you want to move your documentation from Confluence to ClickHelp.
We’re just telling you how to do it.
Before You Begin
Make sure you have the following:
- Administrator access to your Confluence instance.
- Valid login credentials for Confluence.
- An API token (for Cloud/Data Center editions). Learn how to get it here: Manage API tokens for your Atlassian account.
- Knowledge of which space you want to import.
Starting the Import
- Open the Projects page in your ClickHelp portal.
- Click the Import button to launch the Import Wizard.
- Select Confluence as your import source.
- Choose where to import the content:
- Create a new project (recommended if importing an entire space).
- Add to an existing project (useful for partial imports).
Note: In ClickHelp, a Project serves as the equivalent of a Confluence Space.
- If creating a new project:
- Enter a name in the Project name box.
- Specify the Project language from the dropdown.
- Click Next to proceed.
Selecting Your Confluence Edition
The Confluence Login step will open, presenting three options:
- Confluence Server
- Confluence Cloud
- Confluence Data Center
Select the edition that matches your Confluence instance.
Providing Confluence Credentials
In the Confluence portal URL box, enter your portal URL.
If you’re unsure about the exact portal URL, you can insert any link to your Confluence instance (such as a page or space link). ClickHelp will automatically attempt to recognize the correct portal URL.
Next, enter your authentication credentials:
For Confluence Server:
- Enter your Confluence login.
- Enter your Confluence password.
- Click Next.
For Confluence Cloud/Data Center:
- Enter your Confluence login.
- Enter your API token.
- Click Next.
Configuring Import Settings
The Confluence Settings step will open with the following options:
- From the Space name dropdown list, select the Confluence space you want to import.
- If you have the Scroll Versions plugin installed in your Confluence instance, the dropdown becomes available. Select which version of the chosen Space you want to import.
For more information, see the Working with Scroll Versions Plugin section.
- Choose how ClickHelp should handle unsupported macros:
- Remove unsupported macros.
- Replace unsupported macros with placeholders.
Completing the Import
- Click Next to begin the import process.
- Wait for the import to complete (timing depends on space size).
- Review the import summary.
- Click Finish to exit the wizard and view your imported content.
Handling Confluence Macros
During import, ClickHelp converts many common Confluence macros to their ClickHelp equivalents. However, some macros may not have direct equivalents.
You have two options for handling unsupported macros:
- Remove unsupported macros: This option completely removes any macros that can’t be converted, creating cleaner documentation but potentially removing functionality.
- Replace unsupported macros with placeholders: This option inserts placeholder text where unsupported macros were located, making it easier to identify and manually replace them later.
For more details about macro handling, please refer to the Importing Confluence Macros documentation.
Working with Scroll Versions Plugin
If you use Atlassian’s Scroll Versions plugin with your Confluence instance, ClickHelp supports importing specific versions of your documentation.
When the plugin is detected, you’ll see an additional dropdown during import allowing you to select which version to import. This feature is particularly useful for teams that maintain multiple versions of their documentation.
For complete details about Scroll Versions support and version-specific imports, please refer to Confluence Import Specifics.
Conclusion
Want to see if migrating from Confluence to ClickHelp is really that easy? Start your free trial today. Our support team is ready to help you with any questions during your test run.
Good luck with your technical writing!
ClickHelp Team
Author, host and deliver documentation across platforms and devices
