nuclino-to-confluence

A Python script to import a Nuclino Workspaces into a Confluence Space

Based on the Markdown to Confluence Page script by Rittman Mead

Requirements

Python3 and pip3 are required to run this script, if you do not have them already follow these steps

download and install setuptools

curl -O https://bootstrap.pypa.io/ez_setup.py
python3 ez_setup.py

download and install pip

curl -O https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py

Usage

• In Nuclino administrators can export workspaces in the Markdown format, this operation will create a folder with a bunch of .md files.
• Clone this repo
• Install the migration script’s dependencies with

pip3 install -r requirements.txt

• Create an API token for Confluence
• Export the following environment variables:

export CONFLUENCE_ORGNAME=bitrise
export CONFLUENCE_USERNAME=your.username@bitrise.io
export CONFLUENCE_PASSWORD=yourAPItoken

• Run the script with

python3 import.py SPACEKEY path/to/export/folder plan

Where SPACEKEY is your Confluence Space’s key (e.g.: INFRA for the Infra team - https://bitrise.atlassian.net/wiki/spaces/INFRA) and path/to/export/folder is the folder where you keep the exported .md files from Nuclino This will create a subfolder named plan with similar structure you had in Nuclino, you may remove or edit these files in the plan folder:

• The index.md will be the entry-point of the execution
• Every file that is in the same format as the index.md file will be considered as an index-file
• Every index-file, beside index.md represents a subfolder
• In the plan folder IDs has been removed from folder names, but they are still present as suffix on .md files, do not remove them manually, or the execution will mess up your page-names
• Avoid name-duplication! (pages with the same names in other Spaces won't be a problem)
• When you satisfied with the plan you can run

python3 import.py SPACKEY path/to/export/folder execute

This will create the pages in Confluence under your Space (it won’t mess up already existing pages with the same name, but it is not advised to execute the plan many times)

pls keep in mind that Nuclino exports its content to Markdown, and the script turns that into HTML and sends it that way to Confluence, so the translation may not be 100% purrfect 😽