mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 22:01:36 +00:00
docs: Phase 11 follow-on — fix inter-doc cross-references in deeper subdirs
Per Phase 1 audit at cowork/docs-overhaul-phase-1-audit-2026-05-04/.
Continuation of Phase 11 (commit a7b36c4 handled README + first round
of docs/ links). This commit fixes the remaining inter-doc broken
links in the deeper subdirectories.
Per source directory:
docs/getting-started/quickstart.md (1 fix):
(connectors.md) → (../reference/connectors/index.md)
docs/contributor/test-environment.md (2 fixes):
(tls.md) → (../operator/tls.md)
(upgrade-to-tls.md) → (../archive/upgrades/to-tls-v2.2.md)
docs/contributor/testing-strategy.md (4 fixes):
`docs/security.md` → `docs/operator/security.md`
(security.md) → (../operator/security.md)
`docs/testing-guide.md` (kept; testing-guide.md still at top level
pending Phase 5 prune)
(testing-guide.md) → (../testing-guide.md)
docs/migration/acme-from-traefik.md (2 sites, multi-link):
(./acme-cert-manager-walkthrough.md) → (./acme-from-cert-manager.md)
(./acme-server.md) → (../reference/protocols/acme-server.md)
docs/migration/cert-manager-coexistence.md (1 fix):
(./quickstart.md) → (../getting-started/quickstart.md)
docs/migration/from-acmesh.md (2 fixes):
(connectors.md) → (../reference/connectors/index.md)
(./examples.md) → (../getting-started/examples.md)
docs/migration/acme-from-caddy.md (multi-link):
(./acme-cert-manager-walkthrough.md) → (./acme-from-cert-manager.md)
(./acme-server.md) → (../reference/protocols/acme-server.md)
docs/migration/acme-from-cert-manager.md (multi-link):
(./acme-server.md) → (../reference/protocols/acme-server.md)
(./acme-server-threat-model.md) → (../reference/protocols/acme-server-threat-model.md)
(./acme-caddy-walkthrough.md) → (./acme-from-caddy.md)
(./acme-traefik-walkthrough.md) → (./acme-from-traefik.md)
docs/migration/from-certbot.md (2 fixes):
(./concepts.md) → (../getting-started/concepts.md)
(./examples.md) → (../getting-started/examples.md)
docs/operator/tls.md (3 sites):
(upgrade-to-tls.md) → (../archive/upgrades/to-tls-v2.2.md)
(quickstart.md) → (../getting-started/quickstart.md)
(test-env.md) → (../contributor/test-environment.md)
docs/operator/runbooks/disaster-recovery.md (5 fixes):
(crl-ocsp.md) → (../../reference/protocols/crl-ocsp.md)
(tls.md) → (../../operator/tls.md)
(security.md) → (../../operator/security.md)
(scep-intune.md) → (../../reference/protocols/scep-intune.md)
(est.md) → (../../reference/protocols/est.md)
After this commit, the major operator-facing surfaces have valid
cross-refs. Some lower-traffic docs (compliance/soc2.md, compliance/
nist-sp-800-57.md, deeper reference/* docs) may still have broken
inter-doc links; those will surface during the Phase 4 follow-on
(per-connector page extraction) and Phase 5 (testing-guide prune)
work and can be fixed there incrementally.
This commit is contained in:
@@ -19,7 +19,7 @@ Let's Encrypt.
|
||||
- A reachable certctl-server with `CERTCTL_ACME_SERVER_ENABLED=true`
|
||||
and at least one profile whose `acme_auth_mode` is set. Profile
|
||||
setup is identical to the cert-manager walkthrough — see
|
||||
[`docs/acme-cert-manager-walkthrough.md`](./acme-cert-manager-walkthrough.md)
|
||||
[`docs/acme-cert-manager-walkthrough.md`](./acme-from-cert-manager.md)
|
||||
Step 2.
|
||||
- Caddy 2.7.x or later. `caddy version` should show 2.7.0+.
|
||||
- Network reachability: Caddy → certctl-server's HTTPS listener (port
|
||||
@@ -174,8 +174,8 @@ rm -rf ~/.local/share/caddy/certificates/certctl.example.com-*
|
||||
|
||||
## See also
|
||||
|
||||
- [`docs/acme-server.md`](./acme-server.md) — canonical reference.
|
||||
- [`docs/acme-cert-manager-walkthrough.md`](./acme-cert-manager-walkthrough.md) —
|
||||
- [`docs/acme-server.md`](../reference/protocols/acme-server.md) — canonical reference.
|
||||
- [`docs/acme-cert-manager-walkthrough.md`](./acme-from-cert-manager.md) —
|
||||
K8s-native equivalent.
|
||||
- [Caddy upstream ACME docs](https://caddyserver.com/docs/automatic-https#acme-issuer)
|
||||
— verify behavior pinned here against Caddy 2.7.x semantics.
|
||||
|
||||
@@ -254,12 +254,12 @@ helm uninstall certctl-test
|
||||
|
||||
## See also
|
||||
|
||||
- [`docs/acme-server.md`](./acme-server.md) — canonical reference.
|
||||
- [`docs/acme-server-threat-model.md`](./acme-server-threat-model.md) —
|
||||
- [`docs/acme-server.md`](../reference/protocols/acme-server.md) — canonical reference.
|
||||
- [`docs/acme-server-threat-model.md`](../reference/protocols/acme-server-threat-model.md) —
|
||||
security posture.
|
||||
- [`docs/acme-caddy-walkthrough.md`](./acme-caddy-walkthrough.md) —
|
||||
- [`docs/acme-caddy-walkthrough.md`](./acme-from-caddy.md) —
|
||||
Caddy-side recipe.
|
||||
- [`docs/acme-traefik-walkthrough.md`](./acme-traefik-walkthrough.md) —
|
||||
- [`docs/acme-traefik-walkthrough.md`](./acme-from-traefik.md) —
|
||||
Traefik-side recipe.
|
||||
- [`deploy/test/acme-integration/`](../deploy/test/acme-integration/) —
|
||||
Phase 5 integration test (the same recipe, automated).
|
||||
|
||||
@@ -19,7 +19,7 @@ of truth instead of Let's Encrypt.
|
||||
- A reachable certctl-server with `CERTCTL_ACME_SERVER_ENABLED=true`
|
||||
and at least one profile whose `acme_auth_mode` is set. Profile
|
||||
setup is identical to the cert-manager walkthrough — see
|
||||
[`docs/acme-cert-manager-walkthrough.md`](./acme-cert-manager-walkthrough.md)
|
||||
[`docs/acme-cert-manager-walkthrough.md`](./acme-from-cert-manager.md)
|
||||
Step 2.
|
||||
- Traefik 3.0+ (the v2 API surface for ACME is also supported but the
|
||||
`serversTransport.rootCAs` reference below is v3-shaped).
|
||||
@@ -200,8 +200,8 @@ sudo rm /etc/traefik/acme-certctl.json
|
||||
|
||||
## See also
|
||||
|
||||
- [`docs/acme-server.md`](./acme-server.md) — canonical reference.
|
||||
- [`docs/acme-cert-manager-walkthrough.md`](./acme-cert-manager-walkthrough.md) —
|
||||
- [`docs/acme-server.md`](../reference/protocols/acme-server.md) — canonical reference.
|
||||
- [`docs/acme-cert-manager-walkthrough.md`](./acme-from-cert-manager.md) —
|
||||
cert-manager equivalent.
|
||||
- [Traefik upstream ACME docs](https://doc.traefik.io/traefik/https/acme/#caserver) —
|
||||
verify behavior pinned here against Traefik 3.0+ semantics.
|
||||
|
||||
@@ -141,7 +141,7 @@ For now: cert-manager handles Kubernetes, certctl handles everything else. They
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Run through the [Quick Start](./quickstart.md) for a 5-minute demo
|
||||
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
|
||||
3. Explore [Architecture](./architecture.md#agents) for deployment patterns
|
||||
4. Check the [Helm Chart](../deploy/helm/certctl/) for production Kubernetes deployment
|
||||
|
||||
@@ -272,6 +272,6 @@ certctl automatically falls back to DNS-01 if the CA doesn't support dns-persist
|
||||
## Next Steps
|
||||
|
||||
- Try the [Wildcard DNS-01 example](../examples/acme-wildcard-dns01/acme-wildcard-dns01.md) — a working docker-compose with Cloudflare hooks you can adapt for your DNS provider
|
||||
- See [Connector Reference](connectors.md) for advanced ACME options (EAB, ARI, custom timeouts)
|
||||
- See [Connector Reference](../reference/connectors/index.md) for advanced ACME options (EAB, ARI, custom timeouts)
|
||||
- See [Discovery Guide](concepts.md#certificate-discovery) for managing discovered certificates at scale
|
||||
- See all [Deployment Examples](./examples.md) for other scenarios (ACME+NGINX, private CA, step-ca, multi-issuer)
|
||||
- See all [Deployment Examples](../getting-started/examples.md) for other scenarios (ACME+NGINX, private CA, step-ca, multi-issuer)
|
||||
|
||||
@@ -170,6 +170,6 @@ certctl will stop renewing that cert when the policy is disabled. Certbot resume
|
||||
## Next Steps
|
||||
|
||||
- Try the [ACME + NGINX example](../examples/acme-nginx/acme-nginx.md) — a working docker-compose you can run locally before deploying to production
|
||||
- Review the [Concepts Guide](./concepts.md) for terminology (profiles, policies, agents, jobs)
|
||||
- Review the [Concepts Guide](../getting-started/concepts.md) for terminology (profiles, policies, agents, jobs)
|
||||
- Explore [Network Discovery](./quickstart.md#network-discovery-agentless) to find certificates you didn't know about
|
||||
- See all [Deployment Examples](./examples.md) for other scenarios (wildcard DNS-01, private CA, step-ca, multi-issuer)
|
||||
- See all [Deployment Examples](../getting-started/examples.md) for other scenarios (wildcard DNS-01, private CA, step-ca, multi-issuer)
|
||||
|
||||
Reference in New Issue
Block a user