You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/DevDocGuide.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,6 +82,33 @@ Currently there's a definition for the following resource types:
82
82
</table>
83
83
84
84
85
+
## Releasing a new version
86
+
Multiple versions of developer docs are supported and can be switched by the version drop down in the top menu bar. If you're releasing a new version perform the following steps to have your version on the developer docs page.
87
+
88
+
1. Optional: Adjusting your docfx.json
89
+
Depending on whether you want to have the "Improve this doc" to point to a specific version of the github repo you will have to add the following entry to the docfx.json file before calling the docfx command.
If you don't set this up docfx will default to the branch and repo of the current folder you're calling docfx from.
99
+
100
+
2. create your docfx docs by calling docfx docfx.json in the root of the repo
101
+
3. create a folder with the name of your version in the version folder of the gh-pages branch and copy the contents of the generated doc folder into that folder
102
+
4. add your version number into the versionArray in web/version.js
103
+
5. push the modified version.js to mrtk_development branch and the changes in gh-pages branch
104
+
105
+
CI will pick up the changes done to the version.js file and update the version dropdown automatically.
106
+
107
+
### Supporting development branches on CI
108
+
109
+
The versioning system can also be used for showing doc versions from other dev branches that are built by CI. When setting up CI for one of those branches make sure your powershell script on CI copies the contents of the generated docfx output into a version folder named after your branch and add the corresponding version entry into the web/version.js file.
0 commit comments