Skip to content

Commit 51c147c

Browse files
committed
Migrating documentation from docfx.console to docfx
1 parent 0d3a37e commit 51c147c

File tree

18 files changed

+28
-170
lines changed

18 files changed

+28
-170
lines changed

.github/workflows/codeql.yml

Lines changed: 0 additions & 46 deletions
This file was deleted.

.github/workflows/gh-pages.yml

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,37 @@
11
name: DocFx
22
on: workflow_dispatch
3+
permissions:
4+
contents: read
5+
pages: write
6+
id-token: write
37
jobs:
48
build:
59
runs-on: windows-latest
610
steps:
711
- name: Checkout
8-
uses: actions/checkout@v4
9-
- name: Setup .NET 6.0 SDK
10-
uses: actions/setup-dotnet@v4
11-
with:
12-
dotnet-version: '6.0.x'
13-
- name: Setup .NET 7.0 SDK
14-
uses: actions/setup-dotnet@v4
15-
with:
16-
dotnet-version: '7.0.x'
12+
uses: actions/checkout@v6
1713
- name: Setup .NET 8.0 SDK
18-
uses: actions/setup-dotnet@v4
14+
uses: actions/setup-dotnet@v5
1915
with:
2016
dotnet-version: '8.0.x'
21-
- name: Restore
22-
run: dotnet restore
23-
- name: Build
24-
run: dotnet build --configuration Release --no-restore
25-
- name: Upload Artifacts
26-
uses: actions/upload-artifact@v4
17+
- name: Setup .NET 9.0 SDK
18+
uses: actions/setup-dotnet@v5
2719
with:
28-
name: docfx
29-
path: DocFx.AspNetCore.ServerSentEvents/wwwroot
30-
retention-days: 1
31-
publish:
32-
needs: [build]
33-
runs-on: ubuntu-latest
34-
steps:
35-
- name: Checkout
36-
uses: actions/checkout@v4
37-
- name: Download Artifacts
38-
uses: actions/download-artifact@v4
20+
dotnet-version: '9.0.x'
21+
- name: Setup .NET 10.0 SDK
22+
uses: actions/setup-dotnet@v5
3923
with:
40-
name: docfx
41-
path: DocFx.AspNetCore.ServerSentEvents/wwwroot
42-
- name: Publish
43-
uses: JamesIves/[email protected]
24+
dotnet-version: '10.0.x'
25+
- name: Setup docfx
26+
run: dotnet tool update -g docfx
27+
- name: Restore .NET Projects
28+
run: dotnet restore
29+
- name: Build Documentation Artifact
30+
run: docfx docs/docfx.json
31+
- name: Upload Documentation Artifact
32+
uses: actions/upload-pages-artifact@v4
4433
with:
45-
branch: gh-pages
46-
folder: DocFx.AspNetCore.ServerSentEvents/wwwroot
34+
path: 'docs/_artifact'
35+
- name: Deploy Documentation Artifact to GitHub Pages
36+
id: deployment
37+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ bld/
2828
#wwwroot/
2929

3030
# DocFX generated stuff
31-
DocFx.AspNetCore.ServerSentEvents/log.txt
32-
DocFx.AspNetCore.ServerSentEvents/api/
33-
DocFx.AspNetCore.ServerSentEvents/wwwroot/
31+
/docs/api
32+
/docs/_artifact
3433

3534
# MSTest test Results
3635
[Tt]est[Rr]esult*/

DocFx.AspNetCore.ServerSentEvents/DocFx.AspNetCore.ServerSentEvents.csproj

Lines changed: 0 additions & 18 deletions
This file was deleted.

DocFx.AspNetCore.ServerSentEvents/Program.cs

Lines changed: 0 additions & 20 deletions
This file was deleted.

DocFx.AspNetCore.ServerSentEvents/Properties/launchSettings.json

Lines changed: 0 additions & 27 deletions
This file was deleted.

DocFx.AspNetCore.ServerSentEvents/Startup.cs

Lines changed: 0 additions & 18 deletions
This file was deleted.

DocFx.AspNetCore.ServerSentEvents/articles/advanced.md renamed to docs/articles/advanced.md

File renamed without changes.

DocFx.AspNetCore.ServerSentEvents/articles/authorization.md renamed to docs/articles/authorization.md

File renamed without changes.

DocFx.AspNetCore.ServerSentEvents/articles/disconneting-clients.md renamed to docs/articles/disconneting-clients.md

File renamed without changes.

0 commit comments

Comments
 (0)