|
|
@@ -1,4 +1,4 @@
|
|
|
-# Contributing to documentation
|
|
|
+# Contributing to documentation
|
|
|
This documentation serves as a comprehensive guide to help you navigate and contribute to the **Stride Docs** website.
|
|
|
|
|
|
If you're looking to make minor changes, such as adding or updating a manual, tutorial or page, or fixing a typo, feel free to jump straight to the [Content Updates](content.md#content-updates) section.
|
|
|
@@ -16,6 +16,25 @@ Here are the technologies we use to build our website:
|
|
|
- PowerShell scripts
|
|
|
- GitHub Actions (CI/CD) - Don't worry, this is already set up, you don't need to worry about it.
|
|
|
|
|
|
+## Major Version Release Instructions
|
|
|
+
|
|
|
+Assuming the transition is from version `4.1` to `4.2`, and that the Stride source code has been updated to the corresponding .NET version, follow these steps. Note that some steps can be executed at a later stage if needed.
|
|
|
+
|
|
|
+1. Duplicate `ReleaseNotes\ReleaseNotes.md` and rename the copy to `ReleaseNotes-4.1.md`
|
|
|
+1. Update `ReleaseNotes.md`:
|
|
|
+ - Change the content title to `4.2`
|
|
|
+ - Replace the content with the new release notes for version `4.2`
|
|
|
+1. Modify `ReleaseNotes\toc.yml`
|
|
|
+ - `name: 4.2 release notes` with `href: ReleaseNotes.md`
|
|
|
+ - `name: 4.1 release notes` with `href: ReleaseNotes-4.1.md`
|
|
|
+1. In `en\docfx.json`
|
|
|
+ - `_appFooter`: Increase the version number
|
|
|
+ - Change `TargetFramework` to the current framework version being used. Ensure to test this step locally
|
|
|
+1. Edit `versions.json`
|
|
|
+ - Under `versions`, add the new version `4.2`
|
|
|
+
|
|
|
+The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while maintaining accessibility to previous versions.
|
|
|
+
|
|
|
## Table of Contents
|
|
|
|
|
|
- [Understanding the Stride Documentation Generation Pipeline](documentation-generation-pipeline.md)
|
Vaclav Elias