docs: update GitHub Pages documentation #12035
Conversation
DoodlesEpic
changed the title
The previous documentation would suggest to use a bash script which would either be run locally or in a third-party CI, however it's now possible to do the build and deployment step directly through a GitHub Actions workflow, the documentation has been updated to reflect that.
DoodlesEpic
force-pushed
the
docs/github-pages
branch
from
9589e11 to
3f33851
Compare
For some reason the lint stage fails if there are double quotation marks inside the GitHub Actions workflow, hopefully this is the only needed change.
|
Using actions to deploy GitHub Pages is still in public beta. But given that it's been almost half a year since public beta started, maybe we can update the docs. |
'main' is now the default branch name in GitHub. Co-authored-by: 翠 / green <[email protected]>
As noted by sapphi-red in the PR at: vitejs#12035 The rest of the documentation in this page assumes the developer is using NPM, and that makes sense since it's the default, so this workflow example should also default to NPM.
The documentation at static-deploy.md assumes the developer is using the default build path of 'dist', telling that they can change that path or might have to do it to adjust to their setup is just stating the obvious.
The action at https://github.com/actions/setup-node allows you to specify the desired nodejs version which is good for consistency as the system version might change at any moment a new Ubuntu release comes out when using the ubuntu-latest environment.
|
Hey, I applied a formatting change in 0d4bfbe but I'm not sure it was correct to do so? Some code samples in the same file do it with this amount of padding and others do it with 3 spaces of padding, which one would be the correct way? Otherwise, I believe I've applied all the suggestions by @sapphi-red |
|
Thanks!
If the code block is a part of the list, it would need the indent. In this case, I think this code block is part of the "2. Go to your GitHub Pages...". |
Co-authored-by: Bjorn Lu <[email protected]>
Co-authored-by: 翠 / green <[email protected]> Co-authored-by: Bjorn Lu <[email protected]>
Description
The previous documentation would suggest to use a bash script which would either be run locally or in a third-party CI, however it's now possible to do the build and deployment step directly through a GitHub Actions workflow, the documentation has been updated to reflect that.
Additional context
Closes #10938
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123).