Merge pull request 'Plan MIL-005: wiki pages in English, Danish and Bahasa Malaysia' (#30) from mil-005-wiki-and-translations into main
Reviewed-on: #30
This commit was merged in pull request #30.
This commit is contained in:
@@ -10,7 +10,7 @@ each document lives in *this* project and the next version to use.
|
|||||||
| BC | Business Case | docs/business-case.md | 002 |
|
| BC | Business Case | docs/business-case.md | 002 |
|
||||||
| SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 |
|
| SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 |
|
||||||
| PP | Project Plan | docs/project-plan.md | 002 |
|
| PP | Project Plan | docs/project-plan.md | 002 |
|
||||||
| MIL | Milestone / Gateway | docs/milestones/*.md | 005 |
|
| MIL | Milestone / Gateway | docs/milestones/*.md | 006 |
|
||||||
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 008 |
|
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 008 |
|
||||||
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
|
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
|
||||||
|
|
||||||
@@ -24,6 +24,10 @@ each document lives in *this* project and the next version to use.
|
|||||||
|
|
||||||
The PO language is English, so no PO-language translations are kept.
|
The PO language is English, so no PO-language translations are kept.
|
||||||
|
|
||||||
|
The Gitea wiki (MIL-005) is the one exception: its pages are kept in English
|
||||||
|
(authoritative), Danish (`da`) and Bahasa Malaysia (`ms`). Each translated page
|
||||||
|
names the English source version it follows.
|
||||||
|
|
||||||
| Artifact types | Register | Also kept as a PO-language file |
|
| Artifact types | Register | Also kept as a PO-language file |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| BC, KPI, PP, MIL | IT Executive English | No (PO language is English) |
|
| BC, KPI, PP, MIL | IT Executive English | No (PO language is English) |
|
||||||
|
|||||||
@@ -9,8 +9,8 @@
|
|||||||
## Version History
|
## Version History
|
||||||
| Date | Status | Author | Reviewer | Change | Commit |
|
| Date | Status | Author | Reviewer | Change | Commit |
|
||||||
| --- | --- | --- | --- | --- | --- |
|
| --- | --- | --- | --- | --- | --- |
|
||||||
| 2026-10-03 | Deprecated | Jens Tirsvad Nielsen | S01 | Added S05 to assumptions, risks and stakeholders | [4de5438] |
|
|
||||||
| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | A mirrored repository has at most one GitHub push mirror; repositories without one are skipped | [0c06789] |
|
| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | A mirrored repository has at most one GitHub push mirror; repositories without one are skipped | [0c06789] |
|
||||||
|
| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | Scope: wiki pages in English, Danish and Bahasa Malaysia | [08ef26a] |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -66,6 +66,7 @@ made once.
|
|||||||
|
|
||||||
- Gitea Actions workflows (and GitHub-compatible syntax where it is the same).
|
- Gitea Actions workflows (and GitHub-compatible syntax where it is the same).
|
||||||
- Documentation for DevOps professionals and software engineers.
|
- Documentation for DevOps professionals and software engineers.
|
||||||
|
- A Gitea wiki with the same documentation in English, Danish and Bahasa Malaysia (MIL-005).
|
||||||
- Validation of workflow files and their documentation.
|
- Validation of workflow files and their documentation.
|
||||||
|
|
||||||
### Out of Scope
|
### Out of Scope
|
||||||
@@ -148,5 +149,5 @@ Proceed — the first milestone fixes a known defect in the only existing workfl
|
|||||||
---
|
---
|
||||||
|
|
||||||
[SA-001]: ./stakeholder-analysis.md
|
[SA-001]: ./stakeholder-analysis.md
|
||||||
[4de5438]: https://git.tirsystem.com/TirSystem/github-action/commit/4de5438a88b4bbf18b165f52f797d1a52af89f6d
|
|
||||||
[0c06789]: https://git.tirsystem.com/TirSystem/github-action/commit/0c06789a2779382672712cd483f4964b28a0ebe9
|
[0c06789]: https://git.tirsystem.com/TirSystem/github-action/commit/0c06789a2779382672712cd483f4964b28a0ebe9
|
||||||
|
[08ef26a]: https://git.tirsystem.com/TirSystem/github-action/commit/08ef26a6d3eb98c066b45634c2271e578e6c0a0b
|
||||||
|
|||||||
@@ -0,0 +1,77 @@
|
|||||||
|
# MIL-005: Wiki and translations
|
||||||
|
|
||||||
|
## Metadata
|
||||||
|
| Key | Value |
|
||||||
|
| --- | --- |
|
||||||
|
| ID | MIL-005 |
|
||||||
|
| CrossReference | [BC-001] |
|
||||||
|
|
||||||
|
## Version History
|
||||||
|
| Date | Status | Author | Reviewer | Change | Commit |
|
||||||
|
| --- | --- | --- | --- | --- | --- |
|
||||||
|
| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [08ef26a] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Decide whether a reader can find the workflow documentation on the Gitea wiki
|
||||||
|
in English, Danish and Bahasa Malaysia, and whether the wiki stays current
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Go / No-Go Criteria
|
||||||
|
|
||||||
|
| # | Criterion (objectively checkable) | Go | No-Go |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| 1 | The wiki is enabled and contains the five pages in all three languages | 15 pages present | Any page missing |
|
||||||
|
| 2 | Each English page is generated from `README.md` or `guides/`, and a check reports a page that differs from its source | Check passes | Hand-edited page drifts |
|
||||||
|
| 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 |
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
| Depends on | Reason |
|
||||||
|
| --- | --- |
|
||||||
|
| MIL-002 | The wiki pages are built from the onboarding, credentials and troubleshooting guides |
|
||||||
|
|
||||||
|
## Traceability
|
||||||
|
|
||||||
|
| Business Case objective / KPI / user story | Reference |
|
||||||
|
| --- | --- |
|
||||||
|
| O3 | [BC-001] |
|
||||||
|
|
||||||
|
## Ownership
|
||||||
|
|
||||||
|
| Role | Stakeholder ID (SA) |
|
||||||
|
| --- | --- |
|
||||||
|
| Owner | S05 |
|
||||||
|
| Approving reviewer | S01 |
|
||||||
|
|
||||||
|
## Target Date
|
||||||
|
|
||||||
|
2026-12-12 — proposed; to be confirmed by S01 and S05.
|
||||||
|
|
||||||
|
## Tasks
|
||||||
|
|
||||||
|
| # | 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 | |
|
||||||
|
| 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 | |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[BC-001]: ../business-case.md
|
||||||
|
[08ef26a]: https://git.tirsystem.com/TirSystem/github-action/commit/08ef26a6d3eb98c066b45634c2271e578e6c0a0b
|
||||||
+10
-4
@@ -4,19 +4,19 @@
|
|||||||
| Key | Value |
|
| Key | Value |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| ID | PP-001 |
|
| ID | PP-001 |
|
||||||
| CrossReference | [BC-001], [SA-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] |
|
| CrossReference | [BC-001], [SA-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005] |
|
||||||
|
|
||||||
## Version History
|
## Version History
|
||||||
| Date | Status | Author | Reviewer | Change | Commit |
|
| Date | Status | Author | Reviewer | Change | Commit |
|
||||||
| --- | --- | --- | --- | --- | --- |
|
| --- | --- | --- | --- | --- | --- |
|
||||||
| 2026-10-03 | Deprecated | Jens Tirsvad Nielsen | S01 | Owner of every gateway is S05<br>Actors updated | [4de5438] |
|
|
||||||
| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | UC candidate 1: no GitHub mirror is a successful skip | [0c06789] |
|
| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | UC candidate 1: no GitHub mirror is a successful skip | [0c06789] |
|
||||||
|
| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | Added gateway MIL-005 (wiki and translations) | [08ef26a] |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
This plan schedules four milestones that move the repository from one
|
This plan schedules five milestones that move the repository from one
|
||||||
workflow with known defects to a documented, versioned collection of shared
|
workflow with known defects to a documented, versioned collection of shared
|
||||||
workflows. The Business Case sets no deadline, so the dates are proposals.
|
workflows. The Business Case sets no deadline, so the dates are proposals.
|
||||||
|
|
||||||
@@ -34,6 +34,7 @@ workflows. The Business Case sets no deadline, so the dates are proposals.
|
|||||||
| Onboarding and operations guide | [MIL-002] | 2026-10-19 to 2026-10-31 | 2026-10-31 | S05 | None yet | Verified onboarding, credential and diagnosis guide | [Milestone MIL-002] |
|
| Onboarding and operations guide | [MIL-002] | 2026-10-19 to 2026-10-31 | 2026-10-31 | S05 | None yet | Verified onboarding, credential and diagnosis guide | [Milestone MIL-002] |
|
||||||
| Shared quality checks | [MIL-003] | 2026-11-02 to 2026-11-14 | 2026-11-14 | S05 | None yet | Reusable quality-check workflow | [Milestone MIL-003] |
|
| Shared quality checks | [MIL-003] | 2026-11-02 to 2026-11-14 | 2026-11-14 | S05 | None yet | Reusable quality-check workflow | [Milestone MIL-003] |
|
||||||
| Versioned release and publishing | [MIL-004] | 2026-11-16 to 2026-11-28 | 2026-11-28 | S05 | None yet | Release process and reusable release workflow | [Milestone MIL-004] |
|
| Versioned release and publishing | [MIL-004] | 2026-11-16 to 2026-11-28 | 2026-11-28 | S05 | None yet | Release process and reusable release workflow | [Milestone MIL-004] |
|
||||||
|
| Wiki and translations | [MIL-005] | 2026-11-30 to 2026-12-12 | 2026-12-12 | S05 | None yet | Wiki pages in English, Danish and Bahasa Malaysia, kept current by every pull request | Not created yet |
|
||||||
|
|
||||||
```plantuml
|
```plantuml
|
||||||
@startgantt
|
@startgantt
|
||||||
@@ -46,6 +47,8 @@ Project starts 2026-10-05
|
|||||||
[MIL-002 Go/No-Go] happens 2026-10-31
|
[MIL-002 Go/No-Go] happens 2026-10-31
|
||||||
[MIL-003 Go/No-Go] happens 2026-11-14
|
[MIL-003 Go/No-Go] happens 2026-11-14
|
||||||
[MIL-004 Go/No-Go] happens 2026-11-28
|
[MIL-004 Go/No-Go] happens 2026-11-28
|
||||||
|
[MIL-005 Wiki] starts 2026-11-30 and ends 2026-12-12
|
||||||
|
[MIL-005 Go/No-Go] happens 2026-12-12
|
||||||
@endgantt
|
@endgantt
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -57,11 +60,13 @@ Project starts 2026-10-05
|
|||||||
| Documentation for DevOps professionals | [MIL-002] |
|
| Documentation for DevOps professionals | [MIL-002] |
|
||||||
| Gitea Actions workflows for software engineers (quality checks) | [MIL-003] |
|
| Gitea Actions workflows for software engineers (quality checks) | [MIL-003] |
|
||||||
| Gitea Actions workflows for software engineers (release and publishing) | [MIL-004] |
|
| Gitea Actions workflows for software engineers (release and publishing) | [MIL-004] |
|
||||||
|
| Wiki pages in English, Danish and Bahasa Malaysia | [MIL-005] |
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
```
|
```
|
||||||
MIL-001 → MIL-002 → MIL-003 → MIL-004
|
MIL-001 → MIL-002 → MIL-003 → MIL-004
|
||||||
|
MIL-002 → MIL-005
|
||||||
```
|
```
|
||||||
|
|
||||||
A No-Go moves every later window by the rework time of the failed milestone.
|
A No-Go moves every later window by the rework time of the failed milestone.
|
||||||
@@ -241,9 +246,10 @@ no tests, no release process.
|
|||||||
[MIL-002]: ./milestones/mil-002-onboarding-and-operations.md
|
[MIL-002]: ./milestones/mil-002-onboarding-and-operations.md
|
||||||
[MIL-003]: ./milestones/mil-003-quality-checks.md
|
[MIL-003]: ./milestones/mil-003-quality-checks.md
|
||||||
[MIL-004]: ./milestones/mil-004-versioned-release.md
|
[MIL-004]: ./milestones/mil-004-versioned-release.md
|
||||||
|
[MIL-005]: ./milestones/mil-005-wiki-and-translations.md
|
||||||
[Milestone MIL-001]: https://git.tirsystem.com/TirSystem/github-action/milestone/18
|
[Milestone MIL-001]: https://git.tirsystem.com/TirSystem/github-action/milestone/18
|
||||||
[Milestone MIL-002]: https://git.tirsystem.com/TirSystem/github-action/milestone/19
|
[Milestone MIL-002]: https://git.tirsystem.com/TirSystem/github-action/milestone/19
|
||||||
[Milestone MIL-003]: https://git.tirsystem.com/TirSystem/github-action/milestone/20
|
[Milestone MIL-003]: https://git.tirsystem.com/TirSystem/github-action/milestone/20
|
||||||
[Milestone MIL-004]: https://git.tirsystem.com/TirSystem/github-action/milestone/21
|
[Milestone MIL-004]: https://git.tirsystem.com/TirSystem/github-action/milestone/21
|
||||||
[4de5438]: https://git.tirsystem.com/TirSystem/github-action/commit/4de5438a88b4bbf18b165f52f797d1a52af89f6d
|
|
||||||
[0c06789]: https://git.tirsystem.com/TirSystem/github-action/commit/0c06789a2779382672712cd483f4964b28a0ebe9
|
[0c06789]: https://git.tirsystem.com/TirSystem/github-action/commit/0c06789a2779382672712cd483f4964b28a0ebe9
|
||||||
|
[08ef26a]: https://git.tirsystem.com/TirSystem/github-action/commit/08ef26a6d3eb98c066b45634c2271e578e6c0a0b
|
||||||
|
|||||||
Reference in New Issue
Block a user