Migration of markdown pages from Wiki extension to VSTS wiki is a simple 4 step process:
- Clone the VSTS Wiki
- Move & commit all markdown pages to VSTS Wiki
- Run the migration tool provided by Microsoft (link)
- Push the changes to the master branch on VSTS Wiki
Here are the detailed steps for Wiki migration:
-
Go to Wiki* hub in VSTS. Create your first Wiki page (You can create a dummy page and always delete it later)
-
Click on More -> Clone Wiki -> and clone your VSTS Wiki repo using git clone command.
Let the clone location be "LocationA" with respect to the document. E.g with respect to this document "C:\Users\sancha\WikiDemo.wiki"
- Clone the Wiki extension repo. The Wiki will be mapped to a folder given by you during the wiki creation. You can check that by going to "manage wiki" option in the existing wiki as shown below.
The value under the label "Root" is the folder in your repo inside which the existing wiki pages are saved.
-
Say you have cloned the above mentioned "sampleWiki" in the location "C:\wiki\sampleWiki". The wiki pages will be saved in the path "C:\wiki\sampleWiki\ _extensionWiki". Let this be "LocationB" with respect to the document.
-
Create an empty folder in any path of choice in your location machine and let that be "LocationC" with respect to the document.
Just to summarize
- Location A = VSTS Wiki
- Location B = Wiki extension
- Location C = Empty folder where we will run our migration tool
-
Open command prompt as an administrator
-
Run MigrateToVSTSWiki.exe as shown below to copy the files from your existing wiki and copying them to the destination directory provided. During copying, the exe converts the pages to be compliant with VSTS wiki.
Format: MigrateToVSTSWiki.exe /source:LocationB /destination:LocationC
E.g. In the example above:
- "E:\wiki\sampleWiki_extensionWiki" is the folder in which the existing wiki files are present.
- "E:\Temp\Wiki\New" is the empty folder into which the migrates files will get dropped.
-
Now remove all files from the path "LocationA" (if any) apart from the git related files such as .gitignore etc.
-
Copy all the files from the path "LocationC" and paste them into "LocationA"
-
Run git add . to stage all the newly added files in the "LocationA" for commit.
-
Run git commit -m to commit the files that you have staged locally.
- Run git push origin wikiMaster -f .Push the changes on to the default branch of the VSTS Wiki.
Repository for the documentation - https://github.com/Microsoft/vsts-wikiTools
For bugs, questions and discussions please use the GitHub Issues.
Want to learn more about the new and exciting features of VSTS Wiki. Visit this blog post - coming soon for more details.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.