Commit a4b777d
authored
docs: exclude internal plans/specs from Jekyll Pages build; fix Vault secret note (#2508)
## Summary
Follow-up to #2503. Two doc fixes:
1. **Un-break the docs-site build.** #2503 merged
`docs/plans/2026-05-27-multi-github-destination-web.md`, whose embedded
JSDoc object type (`@returns {{host: ...}|null}`) is parsed by Jekyll's
Liquid engine as an unterminated `{{ }}` variable. That threw a
`Liquid::SyntaxError` and failed the `pages build and deployment` run on
`main` (commit `ef66b617`). This workflow only runs on push to `main`,
not on PRs, so neither CI nor review caught it pre-merge.
Fix: add `docs/_config.yml` excluding `plans/` and `specs/`. These are
internal working docs, not the public API reference. This un-breaks the
build, keeps internal plans/specs off the public docs site, and clears a
pre-existing (non-fatal) Liquid warning in
`plans/2026-05-21-slack-observability-web-tier.md`.
2. **Correct the secret-store guidance.** The plan doc and a
`github-targets.js` comment claimed webhook secrets are injected via the
`deploy-secrets` npm script. That script writes to AWS Secrets Manager
from a `secrets/` file absent from the repo and CI. This service
actually loads runtime config from HashiCorp Vault
(`dx_mysticat/{env}/api-service`, KV v2) at cold start via the
`vaultSecrets` middleware (`src/index.js`). Corrected so the runbook
points operators at `vault kv patch`.
## Validation
- Ran the CI action image locally
(`ghcr.io/actions/jekyll-build-pages:v1.0.13`): `_config.yml` loads and
the `Liquid::SyntaxError` is gone. A fully green local build is blocked
only by the `jekyll-github-metadata` plugin's GitHub-API auth (no
network/token in the sandbox), which real CI provides - so the
definitive gate is the post-merge `pages build and deployment` run.
- No functional code change (the only `src/` edit is a one-line
comment).1 parent 631667c commit a4b777d
3 files changed
Lines changed: 15 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
809 | 809 | | |
810 | 810 | | |
811 | 811 | | |
812 | | - | |
| 812 | + | |
813 | 813 | | |
814 | 814 | | |
815 | 815 | | |
| |||
818 | 818 | | |
819 | 819 | | |
820 | 820 | | |
821 | | - | |
822 | | - | |
| 821 | + | |
| 822 | + | |
823 | 823 | | |
824 | 824 | | |
825 | 825 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| |||
0 commit comments