Merge pull request #249 from stride3d/master

Initiating deployment of latest docs updates to staging
stride3d · Feb 10, 2024 · e22b818 · e22b818
2 parents 13aa239 + 73043d2
commit e22b818
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 972 deletions.
diff --git a/.github/workflows/stride-docs-github.yml b/.github/workflows/stride-docs-github.yml
@@ -11,26 +11,26 @@ jobs:
 
     steps:
       - name: Dotnet Setup
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 8.x
 
       - name: Checkout Stride Docs
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: stride-docs
           lfs: true
 
       - name: Checkout Stride (note the LFS)
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: stride3d/stride
           token: ${{ secrets.GITHUB_TOKEN }}
           path: stride
           lfs: true
 
       - name: Install DocFX
-        run: dotnet tool update -g docfx --version 2.74.0
+        run: dotnet tool update -g docfx --version 2.75.2
 
       - name: Build documentation
         run: ./build-all.bat

diff --git a/.github/workflows/stride-docs-release-azure.yml b/.github/workflows/stride-docs-release-azure.yml
@@ -25,20 +25,20 @@ jobs:
     steps:
     # Setup .NET SDK
     - name: Dotnet Setup
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.x
 
     # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         path: stride-docs
         lfs: true
 
     # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         repository: stride3d/stride
         token: ${{ secrets.GITHUB_TOKEN }}
@@ -49,7 +49,7 @@ jobs:
       # This installs the latest version of DocFX and may introduce breaking changes
       # run: dotnet tool update -g docfx
       # This installs a specific, tested version of DocFX.
-      run: dotnet tool update -g docfx --version 2.74.0
+      run: dotnet tool update -g docfx --version 2.75.2
 
     - name: Build documentation
       run: ./build-all.bat
@@ -59,7 +59,7 @@ jobs:
       run: 7z a -r DocFX-app.zip ./stride-docs/_site/*
 
     - name: Upload artifact for deployment job
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: DocFX-app
         path: DocFX-app.zip
@@ -74,7 +74,7 @@ jobs:
 
     steps:
       - name: Download artifact from build job
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: DocFX-app
 

diff --git a/.github/workflows/stride-docs-release-fast-track-azure.yml b/.github/workflows/stride-docs-release-fast-track-azure.yml
@@ -18,20 +18,20 @@ jobs:
     steps:
     # Setup .NET SDK
     - name: Dotnet Setup
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.x
 
     # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         path: stride-docs
         lfs: true
 
     # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         repository: stride3d/stride
         token: ${{ secrets.GITHUB_TOKEN }}
@@ -42,7 +42,7 @@ jobs:
       # This installs the latest version of DocFX and may introduce breaking changes
       # run: dotnet tool update -g docfx
       # This installs a specific, tested version of DocFX.
-      run: dotnet tool update -g docfx --version 2.74.0
+      run: dotnet tool update -g docfx --version 2.75.2
 
     - name: Build documentation
       run: ./build-all.bat

diff --git a/.github/workflows/stride-docs-staging-azure.yml b/.github/workflows/stride-docs-staging-azure.yml
@@ -25,20 +25,20 @@ jobs:
     steps:
     # Setup .NET SDK
     - name: Dotnet Setup
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.x
 
     # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         path: stride-docs
         lfs: true
 
     # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         repository: stride3d/stride
         token: ${{ secrets.GITHUB_TOKEN }}
@@ -49,7 +49,7 @@ jobs:
       # This installs the latest version of DocFX and may introduce breaking changes.
       # run: dotnet tool update -g docfx
       # This installs a specific, tested version of DocFX.
-      run: dotnet tool update -g docfx --version 2.74.0
+      run: dotnet tool update -g docfx --version 2.75.2
 
     - name: Build documentation
       run: ./build-all.bat
@@ -59,7 +59,7 @@ jobs:
       run: 7z a -r DocFX-app.zip ./stride-docs/_site/*
 
     - name: Upload artifact for deployment job
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: DocFX-app
         path: DocFX-app.zip
@@ -74,7 +74,7 @@ jobs:
 
     steps:
       - name: Download artifact from build job
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: DocFX-app
 

diff --git a/.github/workflows/stride-docs-staging-fast-track-azure.yml b/.github/workflows/stride-docs-staging-fast-track-azure.yml
@@ -18,20 +18,20 @@ jobs:
     steps:
     # Setup .NET SDK
     - name: Dotnet Setup
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.x
 
     # Checkout the Stride Docs repository from the branch that triggered the workflow
     - name: Checkout Stride Docs
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         path: stride-docs
         lfs: true
 
     # Checkout the Stride repository from the default branch
     - name: Checkout Stride (note the LFS)
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         repository: stride3d/stride
         token: ${{ secrets.GITHUB_TOKEN }}
@@ -42,7 +42,7 @@ jobs:
       # This installs the latest version of DocFX and may introduce breaking changes
       # run: dotnet tool update -g docfx
       # This installs a specific, tested version of DocFX.
-      run: dotnet tool update -g docfx --version 2.74.0
+      run: dotnet tool update -g docfx --version 2.75.2
 
     - name: Build documentation
       run: ./build-all.bat

diff --git a/.github/workflows/stride-docs-wiki.yml b/.github/workflows/stride-docs-wiki.yml
@@ -1,10 +1,10 @@
 name: Publish to GitHub Wiki
 on:
-  push:
-    branches:
-      - master
-    paths:
-      - wiki/**
+  # push:
+  #  branches:
+  #    - master
+  #  paths:
+  #    - wiki/**
   workflow_dispatch:
 
 jobs:
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-     - uses: actions/checkout@v3
+     - uses: actions/checkout@v4
      - name: Upload Wiki pages
        uses: docker://decathlon/wiki-page-creator-action:2.0.1
        env:

diff --git a/README.md b/README.md
@@ -11,14 +11,14 @@ Welcome to the Stride Docs repository. This repository contains all the source f
 
 ## 🚀 Getting Started
 
-All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs](https://doc.stride3d.net/latest/en/contributors/documentation/index.html).
+All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs - Contributing](https://doc.stride3d.net/latest/en/contributors/documentation/index.html).
 
 ## 🤝 Contributing
 
 Use [Discord](https://discord.gg/f6aerfE) for questions and general discussions. 
 Use [Issues](https://github.com/stride3d/stride-docs/issues) to report bugs and proposing features.
 
-We welcome code contributions through pull requests. Issues tagged as **[`help-wanted`](https://github.com/stride3d/stride-website/labels/help-wanted)** are good candidates for starting to contribute code.
+We welcome code contributions through pull requests. Issues tagged as **[`help wanted`](https://github.com/stride3d/stride-docs/labels/help%20wanted)** are good candidates for starting to contribute code.
 
 ### Branch and Release
 
@@ -36,17 +36,17 @@ The staging website is available at https://stride-doc-staging.azurewebsites.net
 
 ## 🗺️ Roadmap
 
-Our Wiki [Roadmap](https://github.com/stride3d/stride-docs/wiki/Roadmap) communicates upcoming changes to the Stride Docs.
+Our [Roadmap](https://doc.stride3d.net/latest/en/contributors/documentation/roadmap.html) communicates upcoming changes to the Stride Docs.
 
 ## 📖 Stride Documentation Landscape
 
-The Stride documentation landscape is organized across different repositories and their respective wikis to cater to both users and contributors. Here's how it's structured:
+The Stride documentation landscape is organized across different locations. Here's how it's structured:
 
 1. [Stride Website](https://www.stride3d.net/) - Stride's official site showcasing its free, open-source 2D and 3D game engine, alongside blog posts
-   - [Stride Website Wiki](https://github.com/stride3d/stride-website/wiki) - This wiki serves as a comprehensive guide for those looking to contribute to or develop the Stride Website
+   - [Stride Website - Contributing](https://doc.stride3d.net/latest/en/contributors/website/index.html) - This serves as a comprehensive guide for those looking to contribute to or develop the Stride Website
 1. [Stride Docs](https://doc.stride3d.net/) - Here you'll find Stride's documentation, including manuals, tutorials, and API references
-   - [Stride Docs Wiki](https://github.com/stride3d/stride-docs/wiki) - This wiki is a comprehensive guide for individuals interested in contributing to or developing the Stride Docs
-1. [Stride Wiki](https://github.com/stride3d/stride/wiki) - A thorough guide for those who wish to contribute to or develop Stride game engine  
+   - [Stride Docs - Contributing](https://doc.stride3d.net/latest/en/contributors/documentation/index.html) - This is a comprehensive guide for individuals interested in contributing to or developing the Stride Docs
+1. [Stride Wiki](https://github.com/stride3d/stride/wiki) - A thorough guide for those who wish to contribute to or develop Stride game engine 
 
 ## 🌐 .NET Foundation
 

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.10</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.11</p><p>&copy; .NET Foundation and Contributors</p></div>",
       "_gitContribute": {
         "repo": "https://github.com/stride3d/stride-docs",
         "branch": "master"