docs: name the remote that exists, and a push rule for the wiki #49

Merged
jklein merged 2 commits from docs/issue-47-remote-and-wiki-rules into main 2026-09-27 00:00:20 +02:00
Member

Fixes #47

Three documentation defects, two of them in CLAUDE.md and the third already live in the wiki.

1. The remote bullet described something that is not there

It claimed two remotes, github and JLab-Git, and that origin does not exist. The checkout has exactly one remote, origin, pointing at ssh://git@git.jk-dev.de:30022/jlab-cluster/helm-charts.git, and so does every worktree cut from it — verified in this worktree before editing. Two agents stumbled over it.

The bullet now names origin, keeps the point it was making (Gitea is the leading copy, github.com is a mirror fed from Gitea), and keeps "say which remote you mean" as advice for the case it actually applies to: a clone that really has a second remote, such as the maintainer's own.

2. Parallel work on the wiki was unregulated

The wiki is a separate repository with no PR flow, so two editors meet only at push time. During Gitea #16 and #18 two agents edited the same two pages minutes apart; the rebase was clean by luck, and a force push would have deleted the other edit with nothing to report it. The wiki section now says: fetch and rebase before every push, never force-push. The long form in the wiki's Workflow page carries the same rule.

3. The version rows are gone from the chart pages (wiki, already pushed)

A plain app-version bump obliges no wiki edit — that rule is deliberate and stays, because otherwise every automerged Renovate PR would need a wiki commit. What goes is the number that rots because of it: urlaubsverwaltung was already a Renovate round stale.

All 25 chart pages lost their Chart version and App version rows and now point at Chart.yaml, with the same reasoning the chart index has carried from the start. The image repository named in the old app-version row was kept as its own Image row — it is a fact that does not rot, and dropping it would have been collateral damage. Home, Workflow and Forge-and-Tooling were corrected so no page still promises a version snapshot or the wrong remote names. Wiki commit: 311293e.

This PR therefore only updates the CLAUDE.md sentence that explained those numbers as snapshots.

4. Two cross-references that point at the wrong step

Moving the wiki step from 7 to 5 shifted the two items behind it, and the references naming them by number stayed put. The wiki section still called itself "step 7 of the workflow above" — it is step 5. The auto-merge bullet cited "Rule 6 above" for the user merges, never merge yourself, which is rule 7; rule 6 is the agent's lifetime. Both corrected here, in the file this PR already opens, because a number pointing at the wrong step reads as a reason on the next pass. Two words, own commit.

Scope

No chart is touched: no version bump, no install-test, no publish.

Fixes #47 Three documentation defects, two of them in `CLAUDE.md` and the third already live in the wiki. ## 1. The remote bullet described something that is not there It claimed two remotes, `github` and `JLab-Git`, and that `origin` does not exist. The checkout has exactly one remote, `origin`, pointing at `ssh://git@git.jk-dev.de:30022/jlab-cluster/helm-charts.git`, and so does every worktree cut from it — verified in this worktree before editing. Two agents stumbled over it. The bullet now names `origin`, keeps the point it was making (Gitea is the leading copy, github.com is a mirror fed from Gitea), and keeps "say which remote you mean" as advice for the case it actually applies to: a clone that really has a second remote, such as the maintainer's own. ## 2. Parallel work on the wiki was unregulated The wiki is a separate repository with no PR flow, so two editors meet only at push time. During Gitea #16 and #18 two agents edited the same two pages minutes apart; the rebase was clean by luck, and a force push would have deleted the other edit with nothing to report it. The wiki section now says: fetch and rebase before every push, never force-push. The long form in the wiki's `Workflow` page carries the same rule. ## 3. The version rows are gone from the chart pages (wiki, already pushed) A plain app-version bump obliges no wiki edit — that rule is deliberate and stays, because otherwise every automerged Renovate PR would need a wiki commit. What goes is the number that rots because of it: `urlaubsverwaltung` was already a Renovate round stale. All 25 chart pages lost their `Chart version` and `App version` rows and now point at `Chart.yaml`, with the same reasoning the chart index has carried from the start. The image repository named in the old app-version row was kept as its own `Image` row — it is a fact that does not rot, and dropping it would have been collateral damage. `Home`, `Workflow` and `Forge-and-Tooling` were corrected so no page still promises a version snapshot or the wrong remote names. Wiki commit: `311293e`. This PR therefore only updates the `CLAUDE.md` sentence that explained those numbers as snapshots. ## 4. Two cross-references that point at the wrong step Moving the wiki step from 7 to 5 shifted the two items behind it, and the references naming them by number stayed put. The wiki section still called itself "step 7 of the workflow above" — it is step 5. The auto-merge bullet cited "Rule 6 above" for *the user merges, never merge yourself*, which is rule 7; rule 6 is the agent's lifetime. Both corrected here, in the file this PR already opens, because a number pointing at the wrong step reads as a reason on the next pass. Two words, own commit. ## Scope No chart is touched: no version bump, no install-test, no publish.
jlab-bot added 1 commit 2026-09-26 23:43:37 +02:00
docs: name the remote that exists, and a push rule for the wiki
Validate Helm Charts / Detect changed charts (pull_request) Successful in 3s
Validate Helm Charts / Build ${{ fromJSON(needs.detect-changed-charts.outputs.charts) }} (pull_request) Skipped
Validate Helm Charts / Trivy config ${{ fromJSON(needs.detect-changed-charts.outputs.scan-charts) }} (pull_request) Skipped
Validate Helm Charts / Install-test ${{ fromJSON(needs.detect-changed-charts.outputs.install-charts) }} (pull_request) Skipped
Validate Helm Charts / Resource quantities (pull_request) Successful in 8s
1d3bacfb12
The remote bullet described two remotes, github and JLab-Git, and denied
that origin exists. The checkout has exactly one, origin, pointing at the
Gitea instance, and so does every worktree cut from it; two agents lost
time on the difference. The point the bullet made survives — Gitea is the
leading copy, the mirror is fed from there, and where a second remote does
exist the advice to name it still holds.

The wiki has no PR flow, so parallel edits meet only at push time. During
Gitea #16 and #18 two agents edited the same two pages minutes apart and
the rebase happened to be clean; a force push would have deleted the other
edit with nothing to report it. Fetch and rebase before every push, never
force-push.

The chart pages no longer quote versions, so the sentence that explained
them as snapshots now says they carry no numbers at all. That change is
already in the wiki.
jklein added 1 commit 2026-09-26 23:46:11 +02:00
docs: point the two workflow cross-references at the right steps
Validate Helm Charts / Detect changed charts (pull_request) Successful in 3s
Validate Helm Charts / Build ${{ fromJSON(needs.detect-changed-charts.outputs.charts) }} (pull_request) Skipped
Validate Helm Charts / Trivy config ${{ fromJSON(needs.detect-changed-charts.outputs.scan-charts) }} (pull_request) Skipped
Validate Helm Charts / Install-test ${{ fromJSON(needs.detect-changed-charts.outputs.install-charts) }} (pull_request) Skipped
Validate Helm Charts / Resource quantities (pull_request) Successful in 7s
733fea5d9e
Moving the wiki step from 7 to 5 shifted the two items behind it, and the
references that name them by number stayed where they were. The wiki
section still called itself step 7, and the auto-merge bullet cited rule 6
for "the user merges", which is rule 7 — rule 6 is the agent's lifetime.

A number pointing at the wrong step is the kind of reference that passes
for a reason on the next reading, so both are corrected here rather than
in an issue of their own.
jklein approved these changes 2026-09-27 00:00:10 +02:00
jklein merged commit 733fea5d9e into main 2026-09-27 00:00:20 +02:00
jklein deleted branch docs/issue-47-remote-and-wiki-rules 2026-09-27 00:00:22 +02:00
Sign in to join this conversation.
No Reviewers
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jlab-cluster/helm-charts#49