gsadmin/certctl
1
0
Fork 0
mirror of https://github.com/shankar0123/certctl.git synced 2026-06-12 16:08:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix broken ../examples/ links across docs/ (closes #11)

Browse Source 
Reporter (thesudoer0003) flagged that the example links in
docs/getting-started/examples.md resolve to /docs/examples/ which
does not exist. Same bug pattern shows up in four other docs files.

The example READMEs live at examples/<name>/<name>.md at the repo
root, not under docs/. The references in the docs/ tree used
relative paths like `../examples/acme-nginx/acme-nginx.md` which
resolve to docs/examples/... — one level short of escaping out to
the repo root. Fix is one extra `../` so the path resolves to
examples/... at repo root, where the files actually live.

Files touched:
  docs/getting-started/examples.md           5 links
  docs/getting-started/why-certctl.md        1 link
  docs/migration/cert-manager-coexistence.md 1 link
  docs/migration/from-acmesh.md              1 link
  docs/migration/from-certbot.md             1 link

Verified: every `../../examples/<name>/<name>.md` reference now
resolves to the on-disk file. Re-checked via:

  for f in $(grep -rl 'examples/' docs/); do
    for link in $(grep -oE '\.\./\.\./examples/[^)]*' "$f"); do
      [ -e "$(dirname "$f")/$link" ] || echo "STILL BROKEN: $f -> $link"
    done
  done

zero "STILL BROKEN" output.

Closes #11
This commit is contained in:
shankar0123
2026-05-06 20:30:32 +00:00
parent ff6bf8f203
commit 71ebccb8ba
5 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/migration/cert-manager-coexistence.md
+1 -1
View File
@@ -142,6 +142,6 @@ For now: cert-manager handles Kubernetes, certctl handles everything else. They
## Next Steps
1. Run through the [Quick Start](../getting-started/quickstart.md) for a 5-minute demo
2. Try the [Multi-Issuer example](../examples/multi-issuer/multi-issuer.md) — manages public and internal certs from one dashboard
2. Try the [Multi-Issuer example](../../examples/multi-issuer/multi-issuer.md) — manages public and internal certs from one dashboard
3. Explore [Architecture](../reference/architecture.md#agents) for deployment patterns
4. Check the [Helm Chart](../deploy/helm/certctl/) for production Kubernetes deployment