giga/content
2
0
Fork 0
Code Issues 1 Pull requests 2 Projects Releases Packages Wiki Activity Actions

GitBook edition and automatic sync to Cloud for DPI #14

Open
karsten wants to merge 4 commits from gitbook/cloud-for-dpi into main
pull from: gitbook/cloud-for-dpi
merge into: giga:main
Conversation 0 Commits 4 Files changed 83 +5016
karsten commented 2026-10-06 17:31:13 +00:00
Owner
Copy link

Publishes chapters 1 to 5 and the agent skills from giga/cloud-skills in the GitBook space Cloud for DPI. GitBook then stays in step with main.

What changes

  • scripts/build_gitbook.py generates gitbook/ from chapter-<n>/chapter-<n>.md.
    • The overview page follows the sibling course spaces (column tiles, collapsible page index).
    • Each chapter gets a landing page with companion and skill links, then one page per ## section.
    • Figures are referenced from chapter-<n>/graphics/ rather than copied. Numbered citations link to their Further reading source. Lab and video links point to this repository.
  • Agent skills: the content comes from giga/cloud-skills, pinned to commit 910a05f3ac in scripts/gitbook-skills.json.
    • Pages: an overview, two group pages (learning system and OpenStack usage toolkit), one page per skill (14) and the install guide.
    • Each chapter links to its skills.
    • --update-skills moves the pin, so a new skills release always goes through a PR here.
  • .gitbook.yaml points the GitBook import at gitbook/README.md and gitbook/SUMMARY.md.
  • .forgejo/workflows/gitbook.yaml:
    • On pull requests, build_gitbook.py --check fails if gitbook/ is stale.
    • On push to main, it imports that commit into the space and waits for the new GitBook revision.
  • README: a section on the GitBook edition and on the skills pin.

Checks run

  • python3 scripts/build_gitbook.py --check reports 77 pages, 40 figure references and 282 internal links, all resolved, with skills at 910a05f3ac. CI check run #2 succeeded.
  • A word-level comparison of every chapter source and every SKILL.md against the generated pages found no prose missing.
  • This branch was imported into the live space as revision O1chfS3TfePU3shscvqP, with 77 pages. The /content/pages API listed every document page, and each one was requested on the published site: all returned 200. Figure pages, the overview and a skill page were also checked in a browser.
  • Fixed in this PR: two lab links in chapters 3 and 4 whose link text contains inline code pointed to non-existent GitBook pages. The build now fails on any broken internal link.

Infrastructure

  • Org runner giga-content-gitbook (label giga-docker, forgejo-runner v13.1.0) is registered and running.
  • Repository secret GITBOOK_TOKEN is set.

After merge, every later merge to main updates the space. Direct edits in GitBook are overwritten.

Publishes chapters 1 to 5 and the agent skills from `giga/cloud-skills` in the GitBook space **Cloud for DPI**. GitBook then stays in step with `main`. **What changes** - `scripts/build_gitbook.py` generates `gitbook/` from `chapter-<n>/chapter-<n>.md`. - The overview page follows the sibling course spaces (column tiles, collapsible page index). - Each chapter gets a landing page with companion and skill links, then one page per `##` section. - Figures are referenced from `chapter-<n>/graphics/` rather than copied. Numbered citations link to their Further reading source. Lab and video links point to this repository. - **Agent skills:** the content comes from `giga/cloud-skills`, pinned to commit `910a05f3ac` in `scripts/gitbook-skills.json`. - Pages: an overview, two group pages (learning system and OpenStack usage toolkit), one page per skill (14) and the install guide. - Each chapter links to its skills. - `--update-skills` moves the pin, so a new skills release always goes through a PR here. - `.gitbook.yaml` points the GitBook import at `gitbook/README.md` and `gitbook/SUMMARY.md`. - `.forgejo/workflows/gitbook.yaml`: - On pull requests, `build_gitbook.py --check` fails if `gitbook/` is stale. - On push to `main`, it imports that commit into the space and waits for the new GitBook revision. - README: a section on the GitBook edition and on the skills pin. **Checks run** - `python3 scripts/build_gitbook.py --check` reports 77 pages, 40 figure references and 282 internal links, all resolved, with skills at `910a05f3ac`. CI check run #2 succeeded. - A word-level comparison of every chapter source and every `SKILL.md` against the generated pages found no prose missing. - This branch was imported into the live space as revision `O1chfS3TfePU3shscvqP`, with 77 pages. The `/content/pages` API listed every document page, and each one was requested on the published site: all returned 200. Figure pages, the overview and a skill page were also checked in a browser. - Fixed in this PR: two lab links in chapters 3 and 4 whose link text contains inline code pointed to non-existent GitBook pages. The build now fails on any broken internal link. **Infrastructure** - Org runner `giga-content-gitbook` (label `giga-docker`, forgejo-runner v13.1.0) is registered and running. - Repository secret `GITBOOK_TOKEN` is set. After merge, every later merge to `main` updates the space. Direct edits in GitBook are overwritten.
Generate gitbook/ from the canonical chapter sources with
scripts/build_gitbook.py: an overview page in the style of the sibling
course spaces, one landing page per chapter and one page per section.
Figures are referenced from chapter-<n>/graphics, numbered citations
link to their Further reading source, and links to labs and companions
resolve to the repository. .gitbook.yaml points the import at gitbook/.
GitBook sync workflow and section counts
All checks were successful
gitbook / check (pull_request) Successful in 51s
Details
gitbook / publish (pull_request) Has been skipped
Details
c998f5081b 
Add the gitbook workflow: every pull request checks that gitbook/
matches the chapter sources; every push to main imports that commit
into the Cloud for DPI space and waits for the new revision. Count
sections rather than pages in the overview and document the edition
in the repository README.
GitBook edition: publish the agent skills
All checks were successful
gitbook / check (pull_request) Successful in 23s
Details
gitbook / publish (pull_request) Has been skipped
Details
ff4635cfd9 
Add an Agent skills section generated from giga/cloud-skills, pinned to
a reviewed commit in scripts/gitbook-skills.json: an overview with the
learning system and the OpenStack usage toolkit, one page per skill,
the install guide, and links from each chapter to its skills.
--update-skills moves the pin.

Fix two lab links whose text contains inline code; they pointed at
non-existent GitBook pages. The build now fails on any broken internal
link.
GitBook edition: cloud-skills 5ef20352d7
All checks were successful
gitbook / check (pull_request) Successful in 3m4s
Details
gitbook / publish (pull_request) Has been skipped
Details
ba2bb64f41 
Pin giga/cloud-skills main 5ef20352d7 (plugin renamed to giga-cloud-skills,
metadata.provider declared) and regenerate gitbook/. The agent-skills overview
now reads the plugin names from the pinned plugin.json files instead of
hard-coding them.
All checks were successful
gitbook / check (pull_request) Successful in 3m4s
Details
gitbook / publish (pull_request) Has been skipped
Details
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin gitbook/cloud-for-dpi:gitbook/cloud-for-dpi
git switch gitbook/cloud-for-dpi
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
giga/content!14
No description provided.