Skip to content

Commit 4329966

Browse files
VaclavEliasVaclavElias
authored
Merge pull request #471 from stride3d/master
Deploy latest documentation updates to staging
2 parents 0cace0c + a8957e5 commit 4329966

7 files changed

Lines changed: 93 additions & 47 deletions

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

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ jobs:
1616

1717
steps:
1818
- name: .NET SDK Setup
19-
uses: actions/setup-dotnet@v4
19+
uses: actions/setup-dotnet@v5
2020
with:
2121
dotnet-version: 10.x
2222

2323
# Checkout the Stride Docs repository from the branch that triggered the workflow
2424
- name: Checkout Stride Docs
25-
uses: actions/checkout@v5
25+
uses: actions/checkout@v6
2626
with:
2727
path: ${{ env.DOCS_PATH }}
2828
lfs: true
@@ -36,25 +36,55 @@ jobs:
3636

3737
# Checkout the Stride repository from the default branch
3838
- name: Checkout Stride (note the LFS)
39-
uses: actions/checkout@v5
39+
uses: actions/checkout@v6
4040
with:
4141
repository: stride3d/stride
4242
token: ${{ secrets.GITHUB_TOKEN }}
4343
path: stride
4444
lfs: true
45+
ref: master
4546

46-
- name: Install DocFX
47+
# Temporary solution till the new docfx is available
48+
- name: Checkout DocFX
49+
uses: actions/checkout@v6
50+
with:
51+
repository: dotnet/docfx
52+
# Tested commit
53+
ref: 917cda864650279e0bbe50b852cb98601e5efa4d
54+
path: docfx-build
55+
fetch-depth: 0
56+
57+
- name: Restore npm dependencies
58+
run: npm install
59+
working-directory: docfx-build/templates
60+
61+
- name: Build site templates
62+
run: npm run build
63+
working-directory: docfx-build/templates
64+
65+
- name: Build DocFX from PR
66+
run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
67+
working-directory: docfx-build
68+
shell: pwsh
69+
70+
- name: Build Install DocFX
71+
run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
72+
working-directory: docfx-build
73+
shell: pwsh
74+
# End of Temporary solution
75+
76+
#- name: Install DocFX
4777
# This installs the latest version of DocFX and may introduce breaking changes
4878
# run: dotnet tool update -g docfx
4979
# This installs a specific, tested version of DocFX.
50-
run: dotnet tool update -g docfx --version 2.78.3
80+
#run: dotnet tool update -g docfx --version 2.78.3
5181

5282
- name: Build documentation
5383
run: ./build-all.bat
5484
working-directory: ${{ env.DOCS_PATH }}
5585

5686
- name: Deploy
57-
uses: peaceiris/actions-gh-pages@v3.9.2
87+
uses: peaceiris/actions-gh-pages@v4
5888
with:
5989
github_token: ${{ secrets.GITHUB_TOKEN }}
6090
publish_dir: ${{ env.DOCS_PATH }}/_site

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ jobs:
3232

3333
steps:
3434
- name: .NET SDK Setup
35-
uses: actions/setup-dotnet@v4
35+
uses: actions/setup-dotnet@v5
3636
with:
3737
dotnet-version: 10.x
3838

3939
# Checkout the Stride Docs repository from the branch that triggered the workflow
4040
- name: Checkout Stride Docs
41-
uses: actions/checkout@v5
41+
uses: actions/checkout@v6
4242
with:
4343
path: ${{ env.DOCS_PATH }}
4444
lfs: true
@@ -52,7 +52,7 @@ jobs:
5252

5353
# Checkout the Stride repository from the default branch
5454
- name: Checkout Stride (note the LFS)
55-
uses: actions/checkout@v5
55+
uses: actions/checkout@v6
5656
with:
5757
repository: stride3d/stride
5858
token: ${{ secrets.GITHUB_TOKEN }}
@@ -61,12 +61,14 @@ jobs:
6161
ref: master
6262

6363
# Temporary solution till the new docfx is available
64-
- name: Checkout DocFX PR Branch
65-
uses: actions/checkout@v5
64+
- name: Checkout DocFX
65+
uses: actions/checkout@v6
6666
with:
67-
repository: filzrev/docfx
68-
ref: feat-add-net10-support
67+
repository: dotnet/docfx
68+
# Tested commit
69+
ref: 917cda864650279e0bbe50b852cb98601e5efa4d
6970
path: docfx-build
71+
fetch-depth: 0
7072

7173
- name: Restore npm dependencies
7274
run: npm install
@@ -86,7 +88,7 @@ jobs:
8688
working-directory: docfx-build
8789
shell: pwsh
8890
# End of Temporary solution
89-
91+
9092
#- name: Install DocFX
9193
# This installs the latest version of DocFX and may introduce breaking changes
9294
# run: dotnet tool update -g docfx
@@ -101,7 +103,7 @@ jobs:
101103
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
102104

103105
- name: Upload artifact for deployment job
104-
uses: actions/upload-artifact@v5
106+
uses: actions/upload-artifact@v6
105107
with:
106108
name: DocFX-app
107109
path: DocFX-app.zip
@@ -124,7 +126,7 @@ jobs:
124126

125127
steps:
126128
- name: Download artifact from build job
127-
uses: actions/download-artifact@v6
129+
uses: actions/download-artifact@v7
128130
with:
129131
name: DocFX-app
130132

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ jobs:
2626

2727
steps:
2828
- name: .NET SDK Setup
29-
uses: actions/setup-dotnet@v4
29+
uses: actions/setup-dotnet@v5
3030
with:
3131
dotnet-version: 10.x
3232

3333
# Checkout the Stride Docs repository from the branch that triggered the workflow
3434
- name: Checkout Stride Docs
35-
uses: actions/checkout@v5
35+
uses: actions/checkout@v6
3636
with:
3737
path: ${{ env.DOCS_PATH }}
3838
lfs: true
@@ -46,7 +46,7 @@ jobs:
4646

4747
# Checkout the Stride repository from the default branch
4848
- name: Checkout Stride (note the LFS)
49-
uses: actions/checkout@v5
49+
uses: actions/checkout@v6
5050
with:
5151
repository: stride3d/stride
5252
token: ${{ secrets.GITHUB_TOKEN }}
@@ -55,12 +55,14 @@ jobs:
5555
ref: master
5656

5757
# Temporary solution till the new docfx is available
58-
- name: Checkout DocFX PR Branch
59-
uses: actions/checkout@v5
58+
- name: Checkout DocFX
59+
uses: actions/checkout@v6
6060
with:
61-
repository: filzrev/docfx
62-
ref: feat-add-net10-support
61+
repository: dotnet/docfx
62+
# Tested commit
63+
ref: 917cda864650279e0bbe50b852cb98601e5efa4d
6364
path: docfx-build
65+
fetch-depth: 0
6466

6567
- name: Restore npm dependencies
6668
run: npm install

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ jobs:
2929

3030
steps:
3131
- name: .NET SDK Setup
32-
uses: actions/setup-dotnet@v4
32+
uses: actions/setup-dotnet@v5
3333
with:
3434
dotnet-version: 10.x
3535

3636
# Checkout the Stride Docs repository from the branch that triggered the workflow
3737
- name: Checkout Stride Docs
38-
uses: actions/checkout@v5
38+
uses: actions/checkout@v6
3939
with:
4040
path: ${{ env.DOCS_PATH }}
4141
lfs: true
@@ -57,7 +57,7 @@ jobs:
5757

5858
# Checkout the Stride repository from the default branch
5959
- name: Checkout Stride (note the LFS)
60-
uses: actions/checkout@v5
60+
uses: actions/checkout@v6
6161
with:
6262
repository: stride3d/stride
6363
token: ${{ secrets.GITHUB_TOKEN }}
@@ -66,12 +66,14 @@ jobs:
6666
ref: master
6767

6868
# Temporary solution till the new docfx is available
69-
- name: Checkout DocFX PR Branch
70-
uses: actions/checkout@v5
69+
- name: Checkout DocFX
70+
uses: actions/checkout@v6
7171
with:
72-
repository: filzrev/docfx
73-
ref: feat-add-net10-support
72+
repository: dotnet/docfx
73+
# Tested commit
74+
ref: 917cda864650279e0bbe50b852cb98601e5efa4d
7475
path: docfx-build
76+
fetch-depth: 0
7577

7678
- name: Restore npm dependencies
7779
run: npm install
@@ -91,7 +93,7 @@ jobs:
9193
working-directory: docfx-build
9294
shell: pwsh
9395
# End of Temporary solution
94-
96+
9597
#- name: Install DocFX
9698
# This installs the latest version of DocFX and may introduce breaking changes
9799
# run: dotnet tool update -g docfx
@@ -106,7 +108,7 @@ jobs:
106108
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
107109

108110
- name: Upload artifact for deployment job
109-
uses: actions/upload-artifact@v5
111+
uses: actions/upload-artifact@v6
110112
with:
111113
name: DocFX-app
112114
path: DocFX-app.zip
@@ -122,7 +124,7 @@ jobs:
122124

123125
steps:
124126
- name: Download artifact from build job
125-
uses: actions/download-artifact@v6
127+
uses: actions/download-artifact@v7
126128
with:
127129
name: DocFX-app
128130

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ jobs:
2323

2424
steps:
2525
- name: .NET SDK Setup
26-
uses: actions/setup-dotnet@v4
26+
uses: actions/setup-dotnet@v5
2727
with:
2828
dotnet-version: 10.x
2929

3030
# Checkout the Stride Docs repository from the branch that triggered the workflow
3131
- name: Checkout Stride Docs
32-
uses: actions/checkout@v5
32+
uses: actions/checkout@v6
3333
with:
3434
path: ${{ env.DOCS_PATH }}
3535
lfs: true
@@ -43,7 +43,7 @@ jobs:
4343

4444
# Checkout the Stride repository from the default branch
4545
- name: Checkout Stride (note the LFS)
46-
uses: actions/checkout@v5
46+
uses: actions/checkout@v6
4747
with:
4848
repository: stride3d/stride
4949
token: ${{ secrets.GITHUB_TOKEN }}
@@ -52,12 +52,14 @@ jobs:
5252
ref: master
5353

5454
# Temporary solution till the new docfx is available
55-
- name: Checkout DocFX PR Branch
56-
uses: actions/checkout@v5
55+
- name: Checkout DocFX
56+
uses: actions/checkout@v6
5757
with:
58-
repository: filzrev/docfx
59-
ref: feat-add-net10-support
58+
repository: dotnet/docfx
59+
# Tested commit
60+
ref: 917cda864650279e0bbe50b852cb98601e5efa4d
6061
path: docfx-build
62+
fetch-depth: 0
6163

6264
- name: Restore npm dependencies
6365
run: npm install

‎.github/workflows/stride-docs-test-build.yml‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323

2424
# Checkout the Stride Docs repository from the branch that triggered the workflow
2525
- name: Checkout Stride Docs
26-
uses: actions/checkout@v5
26+
uses: actions/checkout@v6
2727
with:
2828
path: ${{ env.DOCS_PATH }}
2929
lfs: true
@@ -45,7 +45,7 @@ jobs:
4545

4646
# Checkout the Stride repository from the default branch
4747
- name: Checkout Stride (note the LFS)
48-
uses: actions/checkout@v5
48+
uses: actions/checkout@v6
4949
with:
5050
repository: stride3d/stride
5151
token: ${{ secrets.GITHUB_TOKEN }}
@@ -54,12 +54,14 @@ jobs:
5454
ref: master
5555

5656
# Temporary solution till the new docfx is available
57-
- name: Checkout DocFX PR Branch
58-
uses: actions/checkout@v5
57+
- name: Checkout DocFX
58+
uses: actions/checkout@v6
5959
with:
60-
repository: filzrev/docfx
61-
ref: feat-add-net10-support
60+
repository: dotnet/docfx
61+
# Tested commit
62+
ref: 917cda864650279e0bbe50b852cb98601e5efa4d
6263
path: docfx-build
64+
fetch-depth: 0
6365

6466
- name: Restore npm dependencies
6567
run: npm install
@@ -94,7 +96,7 @@ jobs:
9496
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
9597

9698
- name: Upload artifact for deployment job
97-
uses: actions/upload-artifact@v5
99+
uses: actions/upload-artifact@v6
98100
with:
99101
name: DocFX-app
100102
path: DocFX-app.zip

‎en/template/public/main.css‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
--bs-link-color-rgb: 218, 8, 48 !important;
88
--bs-link-hover-color-rgb: 174, 6, 38 !important;
99
}
10+
/* Tempory fix, stopped working from docfx 2.78.5 */
11+
/*@media (min-width: 1400px) {
12+
.container-xxl, .container-xl, .container-lg, .container-md, .container-sm, .container {
13+
max-width: 1768px;
14+
}
15+
}*/
1016

1117
.navbar-brand #logo {
1218
width: 124px;

0 commit comments

Comments
 (0)