Repository navigation
Document how the wiki builds and deploys, and remove deploy.sh - #882
Merged
Merged
Conversation
Adds a root README covering the path from pull request to the live site, the Node 22 requirement, why the repo keeps both package-lock.json and yarn.lock, and what the Prettier bot commits are. GitHub now shows this README on the repository page instead of docs/README.md. Removes deploy.sh. It force-pushed a local build straight to gh-pages, bypassing review. All 162 pushes to gh-pages since 2025-10-28 happened inside deploy workflow runs, so the script hasn't been used in that time. The deploy workflow is the only supported way to publish. Updates the contributor guide: drops the instruction to add "last updated" lines (VuePress adds the date automatically, and #710 removed those lines from pages), fixes the style guide lists that rendered as one italic paragraph, and explains the Prettier bot commits. Ignores build output (docs/.vuepress/dist/ and the merged AWS AMI files) so local builds don't leave untracked files.
bennyvasquez
marked this pull request as ready for review
November 10, 2026 22:39
alexiri
approved these changes
Nov 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The repo didn't have any documentation of how a merged change gets to wiki.almalinux.org, and the contributor guide had drifted from how the site works. This fixes both.
New root README. It covers how a change goes live, the Node 22 and yarn setup, why we have two lock files (and how to keep npm from breaking
yarn.lock), what the Prettier bot commits are, and which files are generated. GitHub will show this README on the repo page instead of the wiki homepage fromdocs/README.md.Removes
deploy.sh. It force-pushed a local build straight togh-pages, which skips review entirely. Every push togh-pagessince Oct 28, 2025 (162 of them) happened inside a deploy workflow run, so nobody has used it in over a year. The deploy workflow is now the only way to publish.Contributor guide fixes.
Ignores build output. A local build used to leave
docs/.vuepress/dist/and the merged AWS AMI files as untracked files. They're in.gitignorenow.I built the site locally, checked that the style guide renders as nested lists, confirmed
git statusstays clean after a build, and checked every link in the README.