Skip to content

Commit 1dcdbc2

Browse files
committed
docs: the site now deploys as a Docker image
README gets a Deploying section; the deployment guide no longer says this site is on GitHub Pages. The Pages workflow stays there as an example.
1 parent 069cf99 commit 1dcdbc2

2 files changed

Lines changed: 12 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,16 @@ Components/
7878

7979
## Framework version
8080

81-
The site references `ShellDocs.* 0.1.17-alpha`. On a new release, bump the four package versions in `ShellDocs.Site.csproj` and the CLI version pinned in `.github/workflows/deploy-pages.yml` together.
81+
The site references `ShellDocs.* 0.1.17-alpha`. On a new release, bump the four package versions in `ShellDocs.Site.csproj` together.
82+
83+
## Deploying
84+
85+
The site runs as a Docker image (`Dockerfile`). `.github/workflows/docker.yml` builds it on every pull request, and on every push to `main` pushes it to `docker.zuluville.com/shelldocs-docs` as `:latest` and `:<short commit>`. Registry login uses the repository secrets `REGISTRY_USERNAME` and `REGISTRY_PASSWORD`.
86+
87+
```bash
88+
docker build -t docker.zuluville.com/shelldocs-docs .
89+
docker run --rm -p 8080:8080 docker.zuluville.com/shelldocs-docs
90+
```
8291

8392
## License
8493

‎content/docs/guides/deployment.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ order: 7
66

77
# Deployment
88

9-
A ShellDocs site is a Blazor Web App. You can run it on a .NET host, or export it to static files with `shelldocs build` and serve those from any static host. This site is a static export on GitHub Pages.
9+
A ShellDocs site is a Blazor Web App. You can run it on a .NET host, or export it to static files with `shelldocs build` and serve those from any static host. This site runs on a .NET host, as a Docker image.
1010

1111
## Choosing
1212

@@ -60,7 +60,7 @@ The output goes to `./publish`. Every flag is covered in [shelldocs build](/docs
6060

6161
## GitHub Pages
6262

63-
This is the workflow this site deploys with. It builds on every push to `main` and can be run by hand.
63+
This workflow builds on every push to `main` and can be run by hand.
6464

6565
```yaml
6666
name: Deploy to GitHub Pages

0 commit comments

Comments
 (0)