Merge pull request #246 from stride3d/master

Initiating deployment of latest docs updates to staging
stride3d · Feb 7, 2024 · 13aa239 · 13aa239
2 parents 7bdfe37 + a005623
commit 13aa239
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 13 deletions.
diff --git a/en/ReleaseNotes/ReleaseNotesNext.md b/en/ReleaseNotes/ReleaseNotesNext.md
@@ -0,0 +1,15 @@
+# Stride Release Notes
+
+February 6th, 2024
+
+## What's new
+
+This release includes numerous enhancements and improvements. Here’s what to expect:
+
+### Feature 1
+
+### Feature 2
+
+### Feature 3
+
+### Feature 4
diff --git a/en/contributors/contribution-workflow.md b/en/contributors/contribution-workflow.md
@@ -1,10 +1,10 @@
 # Contribution Workflow for Stride Projects
 
-This guide outlines the fundamental workflow for contributing to various Stride projects, including the Stride Engine, Stride website, and Stride documentation. Whether you're a seasoned contributor or new to the project, this workflow ensures your contributions are effectively integrated.
+This guide outlines the fundamental workflow for contributing to various Stride projects, including the Stride engine, Stride website, and Stride documentation. Whether you're a seasoned contributor or new to the project, this workflow ensures your contributions are effectively integrated.
 
 ## Overview
 
-The contribution process involves several key steps, from forking the repository to having your changes merged into the main project. This workflow is applicable to contributions to the Stride Engine, Stride website, and Stride documentation.
+The contribution process involves several key steps, from forking the repository to having your changes merged into the main project. This workflow is applicable to contributions to the Stride engine, Stride website, and Stride documentation.
 
 ``` mermaid
 %% Define styles

diff --git a/en/contributors/documentation/major-release-workflow.md b/en/contributors/documentation/major-release-workflow.md
@@ -2,26 +2,33 @@
 
 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. Update `manual\requirements\index.md` to reflect the new .NET version references
 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`
-   - [GitHub Release](https://github.com/stride3d/stride/releases) can be used to generate a list **What's Changed**, once the new tag was added
+   - Use [GitHub Release](https://github.com/stride3d/stride/releases) to generate a list of **What's Changed**, once the new tag is added, following the TeamCity build
 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`in two locations to the current framework version being used. Ensure to test this step locally
+   - Update `TargetFramework` in two locations 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`
 1. For GitHub Actions deployment update `*.yml` files in the `.github\workflows\` folder
    - `dotnet-version:` Update to the related .NET version
+1. Merging `master` to `staging` branch will automatically trigger deployment to our [staging environment](https://stride-doc-staging.azurewebsites.net/latest/en/)
+1. ⚠️ Merging `master` to `release` branch will automatically trigger deployment to our production website
+
+> [!CAUTION]
+> ⚠️ You must manually rename the existing folder on the server from `4.1` to `4.1-backup`, otherwise, the deployment to production will delete this folder while deploying to the `4.2` folder. Once `4.2` is deployed, it is safe to rename `4.1-backup` back to `4.1`. Any further deployments will affect only the `4.2` folder.
 
 The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while maintaining accessibility to previous versions. Note, that the deployment profile must be set to not delete existing items.
 
 ## Other locations to update
 
-1. Update [README.md](https://github.com/stride3d/stride/blob/master/README.md) in the Stride repo, Building from source - Prerequisites section, bump .NET version
 1. Modify `contributors\documentation\installation.md`
-   - Update SDK version
+   - Update SDK version references
+1. Modify `contributors\engine\building-source-windows.md`
+   - Update SDK version references
diff --git a/en/contributors/engine/building-source-windows.md b/en/contributors/engine/building-source-windows.md
@@ -1,9 +1,9 @@
-# Building the source to Stride engine
+# Building the source to Stride engine
 
 ## Prerequisites
 
 1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog.
-2. [DotNet SDK 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
+2. [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
    - Run `dotnet --info` in a console or powershell window to see which versions you have installed
 3. [Visual Studio 2022](https://www.visualstudio.com/downloads/) with the following workloads:
    - `.NET desktop development` with `.NET Framework 4.7.2 targeting pack`

diff --git a/en/contributors/major-release-workflow.md b/en/contributors/major-release-workflow.md
@@ -0,0 +1,12 @@
+# [WIP] Major Release Workflow
+
+## Engine
+
+## Admin Tasks
+
+1. Update the Stride repository [README.md](https://github.com/stride3d/stride/blob/master/README.md)
+   - In the "Building from Source - Prerequisites" section, update the .NET SDK version references
+1. Update the Discord #welcome channel
+   - Refresh the SDK version references. If you're unable to edit the message directly, copy its content, delete the original message, and then create a new one with the updated information
+1. Follow the steps outlined in the [Docs Major Release Workflow](documentation/major-release-workflow.md)
+1. Proceed with the steps in the [Website Major Release Workflow](website/major-release-workflow.md)
diff --git a/en/contributors/toc.yml b/en/contributors/toc.yml
@@ -8,6 +8,8 @@ items:
   href: donate.md
 - name: 🤝 Contribution Workflow
   href: contribution-workflow.md
+- name: ⚙️ Major Release Workflow
+  href: major-release-workflow.md
 - name: 🛠️ Contribute to the engine
   expanded: false
   href: engine/index.md

diff --git a/en/contributors/website/major-release-workflow.md b/en/contributors/website/major-release-workflow.md
@@ -2,12 +2,14 @@
 
 1. **Create a Release Blog Post**
    - Place the post inside the `_drafts` folder, which is not deployed, or directly in the `posts` folder for testing in the `staging` environment. Note: If you need to deploy updates to the `release` branch, remember to move the post back to the `_drafts` folder.
-2. **Update `_data\site.json` with the following settings**, which are used in multiple places on the website:
+1. **Update `_data\site.json` with the following settings**, which are used in multiple places on the website:
    - `version`: Increase the version number
      - This helps refresh the cached CSS file
    - `download-version`: Update the version number for downloads
      - Used on the home page
    - `csharp-version`: Update to the current C# version being used
      - Used on the home page and features page
    - `dotnet-version`: Update to the current .NET version being used
-     - Used on the home page and features page
+     - Used on the home page and features page
+1. Merging `master` to `staging` branch will automatically trigger deployment to our [staging environment](https://stride-website-staging.azurewebsites.net/)
+1. ⚠️ Merging `master` to `release` branch will automatically trigger deployment to our production website
diff --git a/en/docfx.json b/en/docfx.json
@@ -58,7 +58,7 @@
       "_enableSearch": true,
       "_appLogoPath": "media/stride-logo-red.svg",
       "_appLogoUrl": "https://www.stride3d.net/",
-      "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.8</p><p>&copy; .NET Foundation and Contributors</p></div>",
+      "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.10</p><p>&copy; .NET Foundation and Contributors</p></div>",
       "_gitContribute": {
         "repo": "https://github.com/stride3d/stride-docs",
         "branch": "master"
@@ -147,4 +147,4 @@
     "keepFileLink": false,
     "disableGitFeatures": false
   }
-}
+}
diff --git a/en/manual/requirements/index.md b/en/manual/requirements/index.md
@@ -34,7 +34,7 @@ To develop for mobile platforms, you also need:
 
 To run games made with Stride, you need:
 
-- .NET 6 if your application is not [self-contained](https://learn.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained)
+- .NET 8 if your application is not [self-contained](https://learn.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained)
 - DirectX11 (included with Windows 10 and later), OpenGL, or Vulkan depending on the platform, and the graphics API override set in your `.csproj`
 - Visual C++ 2015 runtimes (x86 and/or x64, depending on what you set in your project properties in Visual Studio)