Repository navigation
Portal: the HardFOC home page on the shared theme, with a generated repository catalogue - #6
Merged
Merged
Conversation
…d by ru-mkdocs-publish
…tadata.json at build time
…e page, architecture, contribute
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.
Replaces the placeholder MkDocs site with the organisation portal. It is an unversioned site built with the shared HardFOC theme:
ru-mkdocs-publish.ymlwithversioning: false, from hardfoc/hf-general-ci-tools#42.Site
?q=and?topic=work as linksCatalogue generated at build time
tools/portal/catalogue.pyreadsorg/org-metadata.jsonfrom hardfoc/.github through the API. That file is the record for descriptions and topics.has_pagesand each repository's latest release.build/portal/catalogue.md, whichdocs/repositories.mdincludes. The file is not committed.check_commands. The job's read-onlyGH_TOKENis passed in by #42.hardfoc-flux-v1is not; the Flux page says its docs are a CI artifact.tests/test_catalogue.pycovers grouping, card rendering and escaping without the network.Workflow
.github/workflows/docs.yml(📚 Portal) replacesbuild-and-deploy.yml. That workflow ranpeaceiris/actions-gh-pageson every push, to every branch, and wroteCNAMEdocs.hardfoc.dev, a domain that does not resolve.main(or the daily run) publishes the built site as the wholegh-pagesbranch, in one ordinary commit.CNAMEis not carried over: the custom domain comes only from the site (docs/CNAME), and this site has none.@docs/unversioned-sites(the branch of #42) until #42 is released. Then it becomes@v1; this is a one-line follow-up.Checked locally
hardfoc-docs check: the figure is current.mkdocs build --strict: no warnings.Owner / orchestrator steps, in order
@v1.mainruns the deploy job, which replacesgh-pageswith the new site.gh-pages, folder/. Pages servesmaintoday. Check that no custom domain is set; this PR does not set one.curl -sI https://hardfoc.github.io/ | head -1gives 200, and the page title is "HardFOC".