Generate and publish shotover website #1853
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR demonstrates the full website via github pages implementation.
It is temporarily hosted here: https://shotovertest.rukai.xyz/ (running from my github fork of the repo)
And can be compared to the current website at https://shotover.io/
Once the website is deployed we need to follow the steps at https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site for github.com/shotover/shotover-proxy with shotover.io domain.
The current website implementation is hosted at https://github.com/shotover/shotover-website , it is implemented with an early alpha release of vuepress. I previously attempted to upgrade to a modern version of vuepress but gave up because the upgrade changed all kinds of css/html leaving the formatting broken.
This PR implements the website via a new
website
crate in the cargo workspace.Running the website crate generates the website at
website/root
, by following these steps:index.html
docs/index.html
main
branch docs which are intentionally hidden)docs/main
docs/x.y.z
git tag
to find the latest version of breaking releases and then generate mdbook docs from the sub repo after checking out each tag.docs/latest
docs/latest
Intentional changes to the landing page of the original website:
Reviewing
I will split the PR up into 2 separate PRs for easier review: