From d8dc35e88f650228afecb32fa43f8b0e43506226 Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Sun, 11 Oct 2026 10:33:47 +0800 Subject: [PATCH] Name the quality-check wiki page for what it covers Task: MIL-005#3 --- README.md | 8 ++++---- tools/build_wiki.py | 10 +++++----- wiki/Capabilities.da.md | 10 +++++----- wiki/Capabilities.md | 8 ++++---- wiki/Capabilities.ms.md | 10 +++++----- ...lityChecks.da.md => QualityChecksPythonShell.da.md} | 6 +++--- wiki/{QualityChecks.md => QualityChecksPythonShell.md} | 2 +- ...lityChecks.ms.md => QualityChecksPythonShell.ms.md} | 6 +++--- wiki/_Sidebar.md | 6 +++--- 9 files changed, 33 insertions(+), 33 deletions(-) rename wiki/{QualityChecks.da.md => QualityChecksPythonShell.da.md} (92%) rename wiki/{QualityChecks.md => QualityChecksPythonShell.md} (98%) rename wiki/{QualityChecks.ms.md => QualityChecksPythonShell.ms.md} (92%) diff --git a/README.md b/README.md index 197f009..216300e 100644 --- a/README.md +++ b/README.md @@ -65,10 +65,10 @@ Rows that say Implemented or Guides written exist today. The rest is planned and | --- | --- | | Synchronize repository metadata (Gitea to GitHub mirror) | Implemented in `.gitea/scoped_workflows/`, with offline tests and a validation workflow | | Configure and validate workflow credentials | Implemented for the sync workflow: preflight checks both tokens before any change ([guide](guides/credentials.md)) | -| Onboard a repository, manage runners, diagnose failures | Guides written ([onboarding](guides/onboarding.md), [troubleshooting](guides/troubleshooting.md)); scoped delivery to other repositories not yet verified; brief use cases open (MIL-002) | -| Publish a repository wiki from `wiki/` (opt-in, delivered to every organization) | Implemented in `.gitea/scoped_workflows/publish-wiki.yml`, with offline tests; the pilot in a second repository is pending (MIL-006) | -| Shared quality checks (Python and shell) | Implemented as the reusable workflow `.gitea/workflows/quality-checks.yml`, with offline tests and a trial in a second organization; adoption in RepoFoundry is in review ([guide](guides/quality-checks.md)) | -| Versioned release and publishing | Release process, changelog and upgrade guide defined; the release workflow exists; the first release `v1.0.0` is pending (MIL-004) ([guide](guides/upgrading.md)) | +| Onboard a repository, manage runners, diagnose failures | Guides written ([onboarding](guides/onboarding.md), [troubleshooting](guides/troubleshooting.md)); scoped delivery to the repositories of all four organizations verified (MIL-002) | +| Publish a repository wiki from `wiki/` (opt-in, delivered to every organization) | Implemented in `.gitea/scoped_workflows/publish-wiki.yml`, with offline tests; a pilot in a second repository publishes its wiki (MIL-006) | +| Shared quality checks (Python and shell) | Implemented as the reusable workflow `.gitea/workflows/quality-checks.yml`, with offline tests and a trial in a second organization; adopted in RepoFoundry ([guide](guides/quality-checks.md)) | +| Versioned release and publishing | Release process, changelog and upgrade guide defined; the release workflow exists and `v1.0.0` is released (MIL-004) ([guide](guides/upgrading.md)) | ### 🔄 Sync GitHub metadata diff --git a/tools/build_wiki.py b/tools/build_wiki.py index cdff368..c6a310d 100644 --- a/tools/build_wiki.py +++ b/tools/build_wiki.py @@ -43,7 +43,7 @@ PAGES: tuple[Page, ...] = ( Page("Onboarding", "guides/onboarding.md"), Page("Credentials", "guides/credentials.md"), Page("Troubleshooting", "guides/troubleshooting.md"), - Page("QualityChecks", "guides/quality-checks.md"), + Page("QualityChecksPythonShell", "guides/quality-checks.md"), Page("Upgrading", "guides/upgrading.md"), Page("Capabilities", "README.md", ("Capabilities",)), ) @@ -61,7 +61,7 @@ _PAGE_FOR_SOURCE = { "guides/onboarding.md": "Onboarding", "guides/credentials.md": "Credentials", "guides/troubleshooting.md": "Troubleshooting", - "guides/quality-checks.md": "QualityChecks", + "guides/quality-checks.md": "QualityChecksPythonShell", "guides/upgrading.md": "Upgrading", } @@ -187,9 +187,9 @@ def render_page(page: Page, repo_root: Path = REPO_ROOT) -> str: # Link text of the sidebar: English, then one list per translation code. SIDEBAR_TITLE = "TirSystem GitHub Actions" SIDEBAR_LABELS: dict[str, tuple[str, ...]] = { - "en": ("Home", "Onboarding", "Credentials", "Troubleshooting", "Quality checks", "Upgrading", "Capabilities"), - "da": ("Hjem", "Tilslutning", "Credentials", "Fejlfinding", "Kvalitetskontrol", "Opgradering", "Kapabiliteter"), - "ms": ("Utama", "Menyertakan", "Kelayakan", "Diagnosis", "Semakan kualiti", "Menaik taraf", "Keupayaan"), + "en": ("Home", "Onboarding", "Credentials", "Troubleshooting", "Quality checks (Python, shell)", "Upgrading", "Capabilities"), + "da": ("Hjem", "Tilslutning", "Credentials", "Fejlfinding", "Kvalitetskontrol (Python, shell)", "Opgradering", "Kapabiliteter"), + "ms": ("Utama", "Menyertakan", "Kelayakan", "Diagnosis", "Semakan kualiti (Python, shell)", "Menaik taraf", "Keupayaan"), } SIDEBAR_NAME = "_Sidebar.md" diff --git a/wiki/Capabilities.da.md b/wiki/Capabilities.da.md index f808a1f..3f83fcd 100644 --- a/wiki/Capabilities.da.md +++ b/wiki/Capabilities.da.md @@ -1,4 +1,4 @@ - + > Dette er en oversættelse af [`Capabilities`](Capabilities). Den engelske side er autoritativ, og ændringer her bliver overskrevet, næste gang wikien publiceres. @@ -12,10 +12,10 @@ Rækker, der siger Implementeret eller Vejledninger er skrevet, findes i dag. Re | --- | --- | | Synkronisering af repositorymetadata (Gitea til GitHub-spejl) | Implementeret i `.gitea/scoped_workflows/`, med offline-tests og et valideringsworkflow | | Konfiguration og validering af workflow-credentials | Implementeret for synkroniseringsworkflowet: en forhåndskontrol tjekker begge tokens før enhver ændring ([vejledning](Credentials.da)) | -| Tilslutning af et repository, administration af runners, fejlfinding | Vejledninger er skrevet ([tilslutning](Onboarding.da), [fejlfinding](Troubleshooting.da)); scoped levering til andre repositories er ikke verificeret endnu; korte use cases er åbne (MIL-002) | -| Publicering af et repositorys wiki fra `wiki/` (tilmelding, leveres til alle organisationer) | Implementeret i `.gitea/scoped_workflows/publish-wiki.yml`, med offline-tests; pilotforsøget i et andet repository afventer (MIL-006) | -| Fælles kvalitetskontrol (Python og shell) | Implementeret som det genbrugelige workflow `.gitea/workflows/quality-checks.yml`, med offline-tests og et forsøg i en anden organisation; tilslutningen i RepoFoundry er til gennemgang ([vejledning](QualityChecks.da)) | -| Versioneret udgivelse og publicering | Udgivelsesproces, changelog og opgraderingsvejledning er defineret; udgivelsesworkflowet findes; den første udgivelse `v1.0.0` mangler (MIL-004) ([vejledning](Upgrading.da)) | +| Tilslutning af et repository, administration af runners, fejlfinding | Vejledninger er skrevet ([tilslutning](Onboarding.da), [fejlfinding](Troubleshooting.da)); scoped levering til alle fire organisationers repositories er verificeret (MIL-002) | +| Publicering af et repositorys wiki fra `wiki/` (tilmelding, leveres til alle organisationer) | Implementeret i `.gitea/scoped_workflows/publish-wiki.yml`, med offline-tests; et pilotforsøg i et andet repository publicerer sin wiki (MIL-006) | +| Fælles kvalitetskontrol (Python og shell) | Implementeret som det genbrugelige workflow `.gitea/workflows/quality-checks.yml`, med offline-tests og et forsøg i en anden organisation; taget i brug i RepoFoundry ([vejledning](QualityChecksPythonShell.da)) | +| Versioneret udgivelse og publicering | Udgivelsesproces, changelog og opgraderingsvejledning er defineret; udgivelsesworkflowet findes, og `v1.0.0` er udgivet (MIL-004) ([vejledning](Upgrading.da)) | ### Synkronisering af GitHub-metadata diff --git a/wiki/Capabilities.md b/wiki/Capabilities.md index e711e4b..72e8055 100644 --- a/wiki/Capabilities.md +++ b/wiki/Capabilities.md @@ -12,10 +12,10 @@ Rows that say Implemented or Guides written exist today. The rest is planned and | --- | --- | | Synchronize repository metadata (Gitea to GitHub mirror) | Implemented in `.gitea/scoped_workflows/`, with offline tests and a validation workflow | | Configure and validate workflow credentials | Implemented for the sync workflow: preflight checks both tokens before any change ([guide](Credentials)) | -| Onboard a repository, manage runners, diagnose failures | Guides written ([onboarding](Onboarding), [troubleshooting](Troubleshooting)); scoped delivery to other repositories not yet verified; brief use cases open (MIL-002) | -| Publish a repository wiki from `wiki/` (opt-in, delivered to every organization) | Implemented in `.gitea/scoped_workflows/publish-wiki.yml`, with offline tests; the pilot in a second repository is pending (MIL-006) | -| Shared quality checks (Python and shell) | Implemented as the reusable workflow `.gitea/workflows/quality-checks.yml`, with offline tests and a trial in a second organization; adoption in RepoFoundry is in review ([guide](QualityChecks)) | -| Versioned release and publishing | Release process, changelog and upgrade guide defined; the release workflow exists; the first release `v1.0.0` is pending (MIL-004) ([guide](Upgrading)) | +| Onboard a repository, manage runners, diagnose failures | Guides written ([onboarding](Onboarding), [troubleshooting](Troubleshooting)); scoped delivery to the repositories of all four organizations verified (MIL-002) | +| Publish a repository wiki from `wiki/` (opt-in, delivered to every organization) | Implemented in `.gitea/scoped_workflows/publish-wiki.yml`, with offline tests; a pilot in a second repository publishes its wiki (MIL-006) | +| Shared quality checks (Python and shell) | Implemented as the reusable workflow `.gitea/workflows/quality-checks.yml`, with offline tests and a trial in a second organization; adopted in RepoFoundry ([guide](QualityChecksPythonShell)) | +| Versioned release and publishing | Release process, changelog and upgrade guide defined; the release workflow exists and `v1.0.0` is released (MIL-004) ([guide](Upgrading)) | ### Sync GitHub metadata diff --git a/wiki/Capabilities.ms.md b/wiki/Capabilities.ms.md index 83cfc0e..f9ae885 100644 --- a/wiki/Capabilities.ms.md +++ b/wiki/Capabilities.ms.md @@ -1,4 +1,4 @@ - + > Ini ialah terjemahan [`Capabilities`](Capabilities). Halaman bahasa Inggeris ialah teks yang sah, dan perubahan di sini akan ditimpa pada penerbitan wiki yang seterusnya. @@ -12,10 +12,10 @@ Baris yang menyatakan Dilaksanakan atau Panduan telah ditulis wujud hari ini. Se | --- | --- | | Menyegerakkan metadata repositori (Gitea ke cermin GitHub) | Dilaksanakan dalam `.gitea/scoped_workflows/`, dengan ujian luar talian dan aliran kerja pengesahan | | Mengkonfigur dan mengesahkan kelayakan (credentials) aliran kerja | Dilaksanakan untuk aliran kerja penyegerakan: semakan awal (preflight) memeriksa kedua-dua token sebelum sebarang perubahan ([panduan](Credentials.ms)) | -| Menyertakan repositori, mengurus runner, mendiagnosis kegagalan | Panduan telah ditulis ([menyertakan repositori](Onboarding.ms), [diagnosis](Troubleshooting.ms)); penghantaran scoped ke repositori lain belum disahkan; use case ringkas masih terbuka (MIL-002) | -| Menerbitkan wiki repositori daripada `wiki/` (pilih menyertai, dihantar ke setiap organisasi) | Dilaksanakan dalam `.gitea/scoped_workflows/publish-wiki.yml`, dengan ujian luar talian; juruterbang dalam repositori kedua belum dibuat (MIL-006) | -| Semakan kualiti bersama (Python dan shell) | Dilaksanakan sebagai aliran kerja boleh guna semula `.gitea/workflows/quality-checks.yml`, dengan ujian luar talian dan percubaan dalam organisasi kedua; penerimaan dalam RepoFoundry sedang disemak ([panduan](QualityChecks.ms)) | -| Keluaran berversi dan penerbitan | Proses keluaran, changelog dan panduan naik taraf telah ditakrifkan; aliran kerja keluaran sudah ada; keluaran pertama `v1.0.0` belum ada (MIL-004) ([panduan](Upgrading.ms)) | +| Menyertakan repositori, mengurus runner, mendiagnosis kegagalan | Panduan telah ditulis ([menyertakan repositori](Onboarding.ms), [diagnosis](Troubleshooting.ms)); penghantaran scoped ke repositori keempat-empat organisasi telah disahkan (MIL-002) | +| Menerbitkan wiki repositori daripada `wiki/` (pilih menyertai, dihantar ke setiap organisasi) | Dilaksanakan dalam `.gitea/scoped_workflows/publish-wiki.yml`, dengan ujian luar talian; satu juruterbang dalam repositori kedua menerbitkan wikinya (MIL-006) | +| Semakan kualiti bersama (Python dan shell) | Dilaksanakan sebagai aliran kerja boleh guna semula `.gitea/workflows/quality-checks.yml`, dengan ujian luar talian dan percubaan dalam organisasi kedua; digunakan dalam RepoFoundry ([panduan](QualityChecksPythonShell.ms)) | +| Keluaran berversi dan penerbitan | Proses keluaran, changelog dan panduan naik taraf telah ditakrifkan; aliran kerja keluaran sudah ada dan `v1.0.0` telah dikeluarkan (MIL-004) ([panduan](Upgrading.ms)) | ### Menyegerakkan metadata GitHub diff --git a/wiki/QualityChecks.da.md b/wiki/QualityChecksPythonShell.da.md similarity index 92% rename from wiki/QualityChecks.da.md rename to wiki/QualityChecksPythonShell.da.md index 97b347f..1044dd7 100644 --- a/wiki/QualityChecks.da.md +++ b/wiki/QualityChecksPythonShell.da.md @@ -1,8 +1,8 @@ - + -> Dette er en oversættelse af [`QualityChecks`](QualityChecks). Den engelske side er autoritativ, og ændringer her bliver overskrevet, næste gang wikien publiceres. +> Dette er en oversættelse af [`QualityChecksPythonShell`](QualityChecksPythonShell). Den engelske side er autoritativ, og ændringer her bliver overskrevet, næste gang wikien publiceres. -[English](QualityChecks) | Dansk | [Bahasa Melayu](QualityChecks.ms) +[English](QualityChecksPythonShell) | Dansk | [Bahasa Melayu](QualityChecksPythonShell.ms) # Aflæsning af resultater fra kvalitetskontrol diff --git a/wiki/QualityChecks.md b/wiki/QualityChecksPythonShell.md similarity index 98% rename from wiki/QualityChecks.md rename to wiki/QualityChecksPythonShell.md index 3486cb1..d7bb238 100644 --- a/wiki/QualityChecks.md +++ b/wiki/QualityChecksPythonShell.md @@ -2,7 +2,7 @@ > This page is generated from [`guides/quality-checks.md`](https://git.tirsystem.com/TirSystem/github-action/src/branch/main/guides/quality-checks.md). Changes made here are overwritten the next time the wiki is published. -English | [Dansk](QualityChecks.da) | [Bahasa Melayu](QualityChecks.ms) +English | [Dansk](QualityChecksPythonShell.da) | [Bahasa Melayu](QualityChecksPythonShell.ms) # Reading quality-check results diff --git a/wiki/QualityChecks.ms.md b/wiki/QualityChecksPythonShell.ms.md similarity index 92% rename from wiki/QualityChecks.ms.md rename to wiki/QualityChecksPythonShell.ms.md index e8e8bf1..acab59c 100644 --- a/wiki/QualityChecks.ms.md +++ b/wiki/QualityChecksPythonShell.ms.md @@ -1,8 +1,8 @@ - + -> Ini ialah terjemahan [`QualityChecks`](QualityChecks). Halaman bahasa Inggeris ialah teks yang sah, dan perubahan di sini akan ditimpa pada penerbitan wiki yang seterusnya. +> Ini ialah terjemahan [`QualityChecksPythonShell`](QualityChecksPythonShell). Halaman bahasa Inggeris ialah teks yang sah, dan perubahan di sini akan ditimpa pada penerbitan wiki yang seterusnya. -[English](QualityChecks) | [Dansk](QualityChecks.da) | Bahasa Melayu +[English](QualityChecksPythonShell) | [Dansk](QualityChecksPythonShell.da) | Bahasa Melayu # Membaca keputusan semakan kualiti diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md index 71f82b3..c9f4c44 100644 --- a/wiki/_Sidebar.md +++ b/wiki/_Sidebar.md @@ -8,7 +8,7 @@ - [Onboarding](Onboarding) - [Credentials](Credentials) - [Troubleshooting](Troubleshooting) -- [Quality checks](QualityChecks) +- [Quality checks (Python, shell)](QualityChecksPythonShell) - [Upgrading](Upgrading) - [Capabilities](Capabilities) @@ -18,7 +18,7 @@ - [Tilslutning](Onboarding.da) - [Credentials](Credentials.da) - [Fejlfinding](Troubleshooting.da) -- [Kvalitetskontrol](QualityChecks.da) +- [Kvalitetskontrol (Python, shell)](QualityChecksPythonShell.da) - [Opgradering](Upgrading.da) - [Kapabiliteter](Capabilities.da) @@ -28,6 +28,6 @@ - [Menyertakan](Onboarding.ms) - [Kelayakan](Credentials.ms) - [Diagnosis](Troubleshooting.ms) -- [Semakan kualiti](QualityChecks.ms) +- [Semakan kualiti (Python, shell)](QualityChecksPythonShell.ms) - [Menaik taraf](Upgrading.ms) - [Keupayaan](Capabilities.ms) -- 2.54.0