Skip to content

README.md

Latest commit

 

History

History
33 lines (22 loc) · 1.86 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.86 KB
Raw

docs pages

docs.framework

The public documentation site for gloo-foo/framework. Built from nicerobot/template.repo-docs as a self-contained Hugo site, published to GitHub Pages.

Layout

Path Purpose
content/ The documentation — Hugo site content.
layouts/ Hugo templates.
hugo.json Hugo configuration.
.github/workflows/pages.yml The GitHub Pages build workflow. Always present; it self-skips while the repo is private and deploys once the repo is public.
Makefile Local preview and build. Run make for help.

Public, with a self-gating workflow

Everything here is public — it exists to be published, so there is no public//private/ split. Anything private (ideas, tasks, specs) belongs in the project's private hub repo, never here.

GitHub Pages is unavailable on private repos in free orgs, so this repo ships ready to go public: the Pages workflow is always present but self-skips while the repo is private, deploying automatically once the repo is public and Pages is enabled — there is no file to rename.

Preview locally

make serve    # http://localhost:1313

Going public

  1. Make the repository public.
  2. Enable Pages: Settings → Pages → Source: GitHub Actions.
  3. Push (or re-run the pages workflow). It stops self-skipping and publishes the whole site.