Skip to content

Commit ce439a4

Browse files
VaclavEliasVaclavElias
authored
Merge pull request #514 from stride3d/master
Deploy latest documentation updates to staging
2 parents 943ed29 + 001f63f commit ce439a4

165 files changed

Lines changed: 151 additions & 551 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/stride-docs-release-azure.yml‎

Lines changed: 33 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33

44
name: Build Stride Docs for Azure Web App Release 🚀
55

6-
permissions:
7-
contents: write # required to create releases/tags
8-
96
env:
107
COMMON_SETTINGS_PATH: en/docfx.json
118
VERSION: "2.0.0.${{ github.run_number }}"
@@ -23,90 +20,54 @@ on:
2320
- .gitignore
2421
- '.github/**'
2522
workflow_dispatch:
23+
inputs:
24+
skipPdfBuilding:
25+
description: Skip PDF building
26+
required: true
27+
default: true
28+
type: boolean
29+
skipApiBuilding:
30+
description: Skip API building
31+
required: true
32+
default: true
33+
type: boolean
34+
strideBranch:
35+
description: Stride branch to checkout
36+
required: true
37+
default: master
38+
type: string
39+
40+
permissions:
41+
contents: write # required to create releases/tags
2642

2743
jobs:
2844
build:
2945
# Run this job only if the repository is 'stride3d/stride-docs'
3046
if: github.repository == 'stride3d/stride-docs'
31-
runs-on: windows-latest
47+
runs-on: windows-2025-vs2026
3248

3349
steps:
34-
- name: .NET SDK Setup
35-
uses: actions/setup-dotnet@v5
36-
with:
37-
dotnet-version: 10.x
38-
3950
# Checkout the Stride Docs repository from the branch that triggered the workflow
4051
- name: Checkout Stride Docs
4152
uses: actions/checkout@v6
4253
with:
4354
path: ${{ env.DOCS_PATH }}
4455
lfs: true
4556

46-
- name: Set Version in docfx.json
47-
run: |
48-
$settingsContent = Get-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Raw
49-
$updatedDocFxJsonContent = $settingsContent -replace '2.0.0.x', "${{ env.VERSION }}"
50-
Set-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Value $updatedDocFxJsonContent
51-
shell: pwsh
52-
53-
# Checkout the Stride repository from the default branch
54-
- name: Checkout Stride (note the LFS)
55-
uses: actions/checkout@v6
57+
- name: Run Global Setup
58+
id: setup
59+
uses: ./stride-docs/.github/actions/setup-stride
5660
with:
57-
repository: stride3d/stride
58-
token: ${{ secrets.GITHUB_TOKEN }}
59-
path: stride
60-
lfs: true
61-
ref: master
62-
63-
# Temporary solution till the new docfx is available
64-
# - name: Checkout DocFX
65-
# uses: actions/checkout@v6
66-
# with:
67-
# repository: dotnet/docfx
68-
# # Tested commit
69-
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
70-
# path: docfx-build
71-
# fetch-depth: 0
72-
73-
# - name: Restore npm dependencies
74-
# run: npm install
75-
# working-directory: docfx-build/templates
76-
77-
# - name: Build site templates
78-
# run: npm run build
79-
# working-directory: docfx-build/templates
80-
81-
# - name: Build DocFX from PR
82-
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
83-
# working-directory: docfx-build
84-
# shell: pwsh
85-
86-
# - name: Build Install DocFX
87-
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
88-
# working-directory: docfx-build
89-
# shell: pwsh
90-
# End of Temporary solution
91-
92-
- name: Install DocFX
93-
# This installs the latest version of DocFX and may introduce breaking changes
94-
# run: dotnet tool update -g docfx
95-
# This installs a specific, tested version of DocFX.
96-
run: dotnet tool update -g docfx --version 2.78.5
97-
98-
- name: Build documentation
99-
run: ./build-all.bat
100-
working-directory: ${{ env.DOCS_PATH }}
101-
102-
- name: Compress artifact
103-
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
61+
github-token: ${{ secrets.GITHUB_TOKEN }}
62+
skip-pdf-building: ${{ inputs.skipPdfBuilding }}
63+
skip-api-building: ${{ inputs.skipApiBuilding }}
64+
stride-branch: ${{ inputs.strideBranch || 'master' }}
10465

10566
- name: Upload artifact for deployment job
106-
uses: actions/upload-artifact@v6
67+
uses: actions/upload-artifact@v7
10768
with:
10869
name: DocFX-app
109-
path: DocFX-app.zip
70+
path: ./${{ env.DOCS_PATH }}/_site
11071

11172
- name: Create GitHub Release
11273
run: |
@@ -117,7 +78,7 @@ jobs:
11778

11879
deploy:
11980
if: github.repository == 'stride3d/stride-docs'
120-
runs-on: windows-latest
81+
runs-on: windows-2025-vs2026
12182

12283
needs: build
12384
environment:
@@ -126,15 +87,10 @@ jobs:
12687

12788
steps:
12889
- name: Download artifact from build job
129-
uses: actions/download-artifact@v7
90+
uses: actions/download-artifact@v8
13091
with:
13192
name: DocFX-app
132-
133-
# - name: List current directory
134-
# run: ls
135-
136-
- name: Decompress artifact
137-
run: 7z x DocFX-app.zip "-o./${{ env.DOCS_PATH }}/_site"
93+
path: ./${{ env.DOCS_PATH }}/_site
13894

13995
- name: Deploy to Azure Web App
14096
id: deploy-to-webapp
@@ -143,4 +99,4 @@ jobs:
14399
app-name: 'stride-doc'
144100
slot-name: 'Production'
145101
publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_4803638D673FA67D0C8650F34C4FA9D1 }}
146-
package: ./${{ env.DOCS_PATH }}/_site
102+
package: ./${{ env.DOCS_PATH }}/_site

‎.github/workflows/stride-docs-release-fast-track-azure.yml‎

Lines changed: 27 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,94 +4,58 @@
44
# The Fast Track skips creating artifacts and compressing them
55
name: Build Stride Docs (Fast Track) for Azure Web App Release 🚀
66

7-
permissions:
8-
contents: write # required to create releases/tags
9-
107
env:
118
COMMON_SETTINGS_PATH: en/docfx.json
129
VERSION: "2.0.0.${{ github.run_number }}"
1310
DOCS_PATH: stride-docs
1411

1512
on:
1613
workflow_dispatch:
14+
inputs:
15+
skipPdfBuilding:
16+
description: Skip PDF building
17+
required: true
18+
default: true
19+
type: boolean
20+
skipApiBuilding:
21+
description: Skip API building
22+
required: true
23+
default: true
24+
type: boolean
25+
strideBranch:
26+
description: Stride branch to checkout
27+
required: true
28+
default: master
29+
type: string
30+
31+
permissions:
32+
contents: read
1733

1834
jobs:
1935
build-deploy:
2036
# Run this job only if the repository is 'stride3d/stride-docs'
2137
if: github.repository == 'stride3d/stride-docs'
22-
runs-on: windows-latest
38+
runs-on: windows-2025-vs2026
2339

2440
environment:
2541
name: 'Production'
2642

2743
steps:
28-
- name: .NET SDK Setup
29-
uses: actions/setup-dotnet@v5
30-
with:
31-
dotnet-version: 10.x
32-
3344
# Checkout the Stride Docs repository from the branch that triggered the workflow
3445
- name: Checkout Stride Docs
3546
uses: actions/checkout@v6
3647
with:
3748
path: ${{ env.DOCS_PATH }}
3849
lfs: true
3950

40-
- name: Set Version in docfx.json
41-
run: |
42-
$settingsContent = Get-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Raw
43-
$updatedDocFxJsonContent = $settingsContent -replace '2.0.0.x', "${{ env.VERSION }}"
44-
Set-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Value $updatedDocFxJsonContent
45-
shell: pwsh
46-
47-
# Checkout the Stride repository from the default branch
48-
- name: Checkout Stride (note the LFS)
49-
uses: actions/checkout@v6
51+
- name: Run Global Setup
52+
id: setup
53+
uses: ./stride-docs/.github/actions/setup-stride
5054
with:
51-
repository: stride3d/stride
52-
token: ${{ secrets.GITHUB_TOKEN }}
53-
path: stride
54-
lfs: true
55-
ref: master
56-
57-
# Temporary solution till the new docfx is available
58-
# - name: Checkout DocFX
59-
# uses: actions/checkout@v6
60-
# with:
61-
# repository: dotnet/docfx
62-
# # Tested commit
63-
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
64-
# path: docfx-build
65-
# fetch-depth: 0
66-
67-
# - name: Restore npm dependencies
68-
# run: npm install
69-
# working-directory: docfx-build/templates
70-
71-
# - name: Build site templates
72-
# run: npm run build
73-
# working-directory: docfx-build/templates
74-
75-
# - name: Build DocFX from PR
76-
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
77-
# working-directory: docfx-build
78-
# shell: pwsh
79-
80-
# - name: Build Install DocFX
81-
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
82-
# working-directory: docfx-build
83-
# shell: pwsh
84-
# End of Temporary solution
85-
86-
- name: Install DocFX
87-
# This installs the latest version of DocFX and may introduce breaking changes
88-
# run: dotnet tool update -g docfx
89-
# This installs a specific, tested version of DocFX.
90-
run: dotnet tool update -g docfx --version 2.78.5
91-
92-
- name: Build documentation
93-
run: ./build-all.bat
94-
working-directory: ${{ env.DOCS_PATH }}
55+
github-token: ${{ secrets.GITHUB_TOKEN }}
56+
skip-pdf-building: ${{ inputs.skipPdfBuilding }}
57+
skip-api-building: ${{ inputs.skipApiBuilding }}
58+
stride-branch: ${{ inputs.strideBranch }}
9559

9660
- name: Deploy to Azure Web App
9761
id: deploy-to-webapp

‎en/manual/game-studio/add-entities.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ You can duplicate an entity along with all its properties. Duplicating an entity
7171
The entity and all its properties are duplicated.
7272

7373
<video controls autoplay loop height="360" width="480">
74-
<source src="../get-started/media/populate-scene-duplicate-entity.mp4" type="video/mp4">
74+
<source src="media/populate-scene-duplicate-entity.mp4" type="video/mp4">
7575
</video>
7676

7777
Alternatively, right-click the entity and select **Duplicate selected entities**.
7878

79-
![Duplicate selected entities](../get-started/media/duplicate-selected-entities.png)
79+
![Duplicate selected entities](media/duplicate-selected-entities.png)
8080

8181
## Rename an entity
8282

@@ -87,4 +87,4 @@ Alternatively, right-click the entity and select **Duplicate selected entities**
8787

8888
## See also
8989

90-
* [Manage scenes](manage-scenes.md)
90+
* [Manage scenes](manage-scenes.md)

‎en/manual/game-studio/assets.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Some assets require **resource files**. For example, texture assets need image f
88

99
You can compile and optimize assets with a special compiler provided by Stride. Compiled assets are packed together as reusable bundles.
1010

11-
![Assets displayed in the Asset View](../get-started/media/asset-creation-asset-view-tab-knight.png)
11+
![Assets displayed in the Asset View](media/asset-creation-asset-view-tab-knight.png)
1212

1313
You can:
1414

@@ -32,4 +32,4 @@ You can:
3232

3333
* [Create assets](create-assets.md)
3434
* [Manage assets](manage-assets.md)
35-
* [Use assets](use-assets.md)
35+
* [Use assets](use-assets.md)

‎en/manual/game-studio/create-assets.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ There are two ways to create assets:
1313

1414
2. Select the type of asset you want to create.
1515

16-
![Select asset type](../get-started/media/asset-creation-create-new-asset-asset-view-tab.png)
16+
![Select asset type](media/asset-creation-create-new-asset-asset-view-tab.png)
1717

1818
Game Studio displays a list of asset templates. These are assets configured for a specific use.
1919

2020
3. Select the right template for your asset.
2121

2222
Game Studio adds the asset to the Asset View:
2323

24-
![Asset added to Asset View' tab](../get-started/media/asset-creation-asset-view-tab-procedural-model.png)
24+
![Asset added to Asset View' tab](media/asset-creation-asset-view-tab-procedural-model.png)
2525

2626
> [!Note]
2727
> Some assets, such as textures, require a resource file. When you add these assets, Game Studio prompts you for a resource file.
@@ -63,4 +63,4 @@ Game Studio automatically imports all dependencies in the resource files and cre
6363
## See also
6464

6565
* [Manage assets](manage-assets.md)
66-
* [Use assets](use-assets.md)
66+
* [Use assets](use-assets.md)

‎en/manual/game-studio/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Game Studio is also integrated with your Visual Studio projects, so you can seam
1313

1414
## Interface
1515

16-
![Game Studio](../get-started/media/game-studio-main-interface.webp)
16+
![Game Studio](media/game-studio-main-interface.webp)
1717

1818
The **asset editor** (1) is used to edit assets and scenes. Some asset types, such as [scenes](create-a-scene.md), have dedicated editors where you can make complex changes to the asset. To open a dedicated editor (when available), double-click the asset or right-click it and select **Edit asset**.
1919

0 commit comments

Comments
 (0)