Skip to main content

Plan for migrating to MT4 (MT4)

Written by James Valent
Director of Support at MindTouch

This page applies to:MindTouch 4

This article outlines the necessary steps for restructuring your content within MindTouch 4 after a successfully completed content migration by MindTouch Customer Success. This article is most relevant for subject matter experts, technical writers and site owners.
 

Migrating to MindTouch 4

Content from MindTouch Core/Platform, and MindTouch TCS can be migrated to MindTouch 4. Looking to migrate to MindTouch 4? Contact your Account Manager today!

 

After your migration

So you’ve decided to migrate to MindTouch 4. We’re absolutely ecstatic that you’re updating to the leading collaborative documentation platform.While the MindTouch Customer Success team handles the bulk of your data migration from MindTouch Platform/Core or MindTouch TCS, your content will likely need to be restructured to get the most out of the MindTouch content structure framework

As you start to restructure, please utilize the following spreadsheet which will help your team plan as you near your final migration period.

download icon.png

Click to download Migration Planning Workbook

Understanding the MindTouch framework

MindTouch 4 utilizes a content structure framework as the architecture for your documentation. We highly recommend you review our documentation on the MindTouch content structure framework to understand how to best utilize this structure, utilizing both User Guides and Knowledge Bases.

Identifying content structure

Categories

On the first tab of the spreadsheet, we recommend you get started by identifying your main Categories:

categories tab selected in workbook.png

Category Name Identify the Category name.
Image Description Describe the image you'd like to have represent your Category.
URL Indicate the desired URL of the Category.
Owner Optionally choose an owner for this Category's restructuring.
Restructure Completed? Utilize an X to indicate if this restructure has been completed.

category sheet in workbook

Guides

On the second tab of the spreadsheet, you should focus on outlining which guides will comprise each category. In addition, determine a Guide type and permissions here.

guide tab selected in workbook

Category Name Identify the Category where each Guide will live.
Guide Name Identify the name of the Guide.
Guide Type Indicate if this is a User Guide or Knowledge Base
Permission Identify the permission level of the page (i.e., Public, Semi-Public, Semi-Private, or Private)
Permission List If Semi-Public, Semi-Private, or Private, identify which users will have access to the page
URL Indicate the desired URL of the Guide. 
Owner Optionally choose an owner for this Category's restructuring.
Restructure Completed? Utilize an X to indicate if this restructure has been completed.

guide sheet in workbook

Articles

Within the third tab of the spreadsheet, you can outline key articles which you'll want to ensure specific permission settings on. The intent here is not to fully outline all article details in this spreadsheet--we understand that can be too cumbersome. Instead, utilize this tab for focusing on those articles which should accessible or editable by only specific users within your site.

article tab selected in workbook

Category Name Identify the Category where each Guide will live.
Guide Name Identify the name of the Guide.
Article Name Indicate the name of the Article
Article Type Indicate the desired Article Type for this article (i.e., Topic, How-To, or Reference)
Permission Identify the permission level of the page (i.e., Public, Semi-Public, Semi-Private, or Private)
Permission List If Semi-Public, Semi-Private, or Private, identify which users will have access to the page
URL Indicate the desired URL of the Guide.
Owner Optionally choose an owner for this Category's restructuring.
Restructure Completed? Utilize an X to indicate if this restructure has been completed.

article sheet in workbook

Pro Members and Community Members

The fourth and fifth tabs in the workbook will help outline any changes to you wish to make with regards to your users rights in MindTouch.

pro and community member tabs selected in workbook

Username Indicate the username
Display Name Indicate the human readable version of the user which will be displayed in various places within the MindTouch user interface.
Email Address Indicate the user's email address
Role Indicate the user's role. Only Pro Members have varying roles.
Group Membership Indicate the user's group membership for use when permissioning pages.

pro members sheet in workbook

Be sure to familiarize yourself with the different user types in MindTouch 4 before appropriating users.

 

  • Was this article helpful?