docs: point all docs links to undermountain.cc/labs/hermes-operator#12
Merged
Conversation
The docs are now published as a subsite of undermountain.cc (cloned + built by the web repo, served at /labs/hermes-operator/) rather than this repo's GitHub Pages. Update every reference: - README (Quickstart / API reference / Examples), CONTRIBUTING, the Helm chart NOTES.txt, and mkdocs.yml site_url -> undermountain.cc/labs/hermes-operator. - Repurpose the Docs workflow from 'build + deploy to GitHub Pages' to a strict mkdocs build check (Pages is no longer used; publishing happens on the web side). Keeps the broken-link/nav gate on docs PRs, drops the pages:write/id-token perms and the deploy steps. Signed-off-by: Tom Bar <martinloy.uy@gmail.com>
Public-launch prep: - Swap all workflow runners from the self-hosted ucc-org-runners pool to ubuntu-latest. Self-hosted was only to dodge the Free-plan billing wall while private; public repos get free GitHub-hosted minutes. - Add paths-ignore: ['**.md','docs/**'] to ci.yml + test-e2e.yml so doc-only PRs skip the Go build/lint and the ~20-min E2E suite. - Add a disk-free step to the E2E job: ubuntu-latest has ~14GB free, and the suite pulls a 2.5GB image (+ a 2.5GB tar) plus Kind node images; reclaiming the preinstalled dotnet/android/CodeQL toolchains keeps it from filling up. Signed-off-by: Tom Bar <martinloy.uy@gmail.com>
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
1 participant
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.
Docs are now published as a subsite of undermountain.cc (the web repo clones this repo, builds the MkDocs site, and serves it at
/labs/hermes-operator/) instead of this repo's GitHub Pages.Changes
undermountain.cc/labs/hermes-operator): README (Quickstart / API reference / Examples), CONTRIBUTING, Helm chartNOTES.txt, anddocs/mkdocs.ymlsite_url.docs.ymlrepurposed: from build + deploy to GitHub Pages → a strictmkdocs build --strictcheck (broken-link/nav gate) on docs PRs. Dropspages:write/id-token:writeand the deploy steps. Pages is no longer used (it was reset off when the repo was recreated), so the old deploy would have failed on merge anyway.ci.ymlandtest-e2e.ymltrigger on every PR to main with no path filters, so this docs-only PR will spin up the ~22-min E2E suite for no reason. Happy to add apaths-ignore: ['**.md', 'docs/**'](or equivalent) to those workflows so doc-only changes skip the heavy Go/E2E runs — say the word and I'll fold it in here or as a follow-up.🤖 Generated with Claude Code