From 77c52779c46bca35dee4d73e587ca7b611373790 Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Sat, 10 Oct 2026 08:46:27 +0800 Subject: [PATCH 1/2] Amend MIL-005: publish the wiki from wiki/ through a workflow on merge Records the decision for task 2: the page source lives in this repository, reaches the wiki repository only through a workflow, and the agent never pushes to it. Adds task 8 for the publishing workflow and a Go/No-Go criterion that no manual push exists. --- docs/milestones/mil-005-wiki-and-translations.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/milestones/mil-005-wiki-and-translations.md b/docs/milestones/mil-005-wiki-and-translations.md index 9dd3954..67413e4 100644 --- a/docs/milestones/mil-005-wiki-and-translations.md +++ b/docs/milestones/mil-005-wiki-and-translations.md @@ -10,6 +10,7 @@ | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | | 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [08ef26a] | +| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | Decided how the wiki is published: source in `wiki/`, published by a workflow on merge
Added task 8 | pending | --- @@ -22,9 +23,11 @@ because every pull request updates it. ## Deliverable A Gitea wiki with the pages Home, Onboarding, Credentials, Troubleshooting -and Capabilities in English (authoritative), Danish and Bahasa Malaysia, a -script that builds the wiki pages from `README.md` and `guides/`, and a -pull request rule in `AGENTS.md` that keeps the wiki current. +and Capabilities in English (authoritative), Danish and Bahasa Malaysia. The +page source lives in `wiki/` in this repository and is reviewed through pull +requests. A script builds the English pages from `README.md` and `guides/`, +a workflow publishes `wiki/` to the wiki repository when a change is merged +to `main`, and a pull request rule in `AGENTS.md` keeps the wiki current. ## Go / No-Go Criteria @@ -35,6 +38,7 @@ pull request rule in `AGENTS.md` that keeps the wiki current. | 3 | Each Danish and Bahasa Malaysia page names the English source version it follows | Named on every page | Missing | | 4 | A native reader of each language has reviewed the translations | Review recorded | Unreviewed | | 5 | `AGENTS.md` requires a wiki update in every pull request that changes a workflow, a guide or the README, and the PR description lists the pages changed | Rule present and used by one PR | Missing | +| 6 | The wiki is published only by the workflow from `main`; no agent or person pushes to the wiki repository by hand | Last wiki commit is by the workflow | A manual push exists | ## Dependencies @@ -64,12 +68,13 @@ pull request rule in `AGENTS.md` that keeps the wiki current. | # | Task | Summary | Needs its own Use Case/User Story? | Reference | | --- | --- | --- | --- | --- | | 1 | Decide wiki structure, languages and source of truth | Fix the page list, the page naming for `da` and `ms` (for example `Home`, `Home.da`, `Home.ms`) and that the English wiki pages are generated from `README.md` and `guides/`. Record the wiki languages in the `Languages` section of `docs/artifact-registry.md`, since the registry currently says no translations are kept. | No | | -| 2 | Enable the Gitea wiki and agree access | The wiki is a separate git repository (`github-action.wiki.git`). Enable it on the repository and decide whether the agent pushes to it with a token or prepares changes for review. | No | | -| 3 | Generate the English wiki pages | Add a script that builds the five pages from `README.md` and `guides/`, rewrites links so they work inside the wiki, and reports a page that differs from its source. | No | | +| 2 | Enable the Gitea wiki and agree access | Decision (2026-10-10): the page source lives in `wiki/` in this repository and reaches the wiki repository (`github-action.wiki.git`) only through a workflow that runs on merge to `main`; the agent edits `wiki/` on a branch and opens a pull request and never pushes to the wiki repository. This task enables the wiki on the repository and creates a secret that can write to the wiki repository only, approved by S05 and stored by S03. Edits made in the Gitea web UI are overwritten on the next publish, and the wiki home page says so. | No | | +| 3 | Generate the English wiki pages | Add a script that builds the five pages into `wiki/` from `README.md` and `guides/`, rewrites links so they work inside the wiki, and reports a page that differs from its source. | No | | | 4 | Draft the Danish and Bahasa Malaysia pages | Translate each page and name the English source version at the top of the page. Keep technical terms (workflow, secret, runner, mirror) consistent through a small term list. | No | | | 5 | Have the translations reviewed | A native reader of Danish and of Bahasa Malaysia reviews the drafts and the findings are fixed before publishing. | No | | | 6 | Add the wiki update rule to the pull request process | Add a rule to `AGENTS.md`: a pull request that changes a workflow, a guide or the README also updates the matching wiki pages in all three languages, and its description lists the pages changed. | No | | | 7 | Publish and verify | Publish the pages, open them in the browser in each language and check that links, code blocks and the capability table render. | No | | +| 8 | Add the wiki publishing workflow | Add a Gitea workflow, canonical in `.gitea/scoped_workflows/`, that runs on push to `main` when `wiki/` changes and copies `wiki/` to the wiki repository with the secret from task 2. It needs least-privilege permissions, must not print the secret, and gets offline tests like the metadata sync, with the same categorized error messages. | No | | --- From 1114b742dc538e34aea20966f23df19a16e9c54e Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Sat, 10 Oct 2026 08:46:28 +0800 Subject: [PATCH 2/2] Resolve pending commit link in MIL-005 --- docs/milestones/mil-005-wiki-and-translations.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/milestones/mil-005-wiki-and-translations.md b/docs/milestones/mil-005-wiki-and-translations.md index 67413e4..927a31b 100644 --- a/docs/milestones/mil-005-wiki-and-translations.md +++ b/docs/milestones/mil-005-wiki-and-translations.md @@ -10,7 +10,7 @@ | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | | 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [08ef26a] | -| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | Decided how the wiki is published: source in `wiki/`, published by a workflow on merge
Added task 8 | pending | +| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | Decided how the wiki is published: source in `wiki/`, published by a workflow on merge
Added task 8 | [77c5277] | --- @@ -80,3 +80,4 @@ to `main`, and a pull request rule in `AGENTS.md` keeps the wiki current. [BC-001]: ../business-case.md [08ef26a]: https://git.tirsystem.com/TirSystem/github-action/commit/08ef26a6d3eb98c066b45634c2271e578e6c0a0b +[77c5277]: https://git.tirsystem.com/TirSystem/github-action/commit/77c52779c46bca35dee4d73e587ca7b611373790