Commit 8d32b2c
docs(docs): v4 guides phase 2c — ship deployment, contributing, upgrading, glossary (#2181)
* docs(docs): phase 2c plan — ship deployment, contributing, upgrading, glossary
Closes the gap flagged in the post-merge correction on PR #2169: those four
sections shipped as placeholder stubs only, not the content the PR body
described. Plan scopes 14 pages (6 Deployment + 4 Contributing + 3 Upgrading
+ Glossary rewrite) plus sidebar wiring, scoped .ai/ audit, and completion
report.
Scope decisions recorded in the plan:
- Deployment teaches user-authored Dockerfiles + nginx/systemd (no
wheels docker/wheels deploy commands fabricated — neither exists in v4)
- Kamal port: one sentence + link from deployment/index.mdx to the
implementation plan, with grep-able TODO to swap to PR URL later
- Dockerfile reference is Lucee 7 canonical; others mentioned in a note
- upgrading/2x-to-3x is a ~1-screen pointer to v3.0 guides
- Glossary hand-curated from Phase 2a/2b terms, ~30-50 entries
- .ai/ audit scoped to Phase 2c topics, not a full sweep
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): deployment/index — landing page for deployment & operations
Explains the two deployment models Wheels supports today (Docker, VM) and the
"what the framework gives you vs what you assemble" boundary. Notes that
wheels deploy (Kamal port) is in active development, with a grep-able TODO
to swap the placeholder for a PR/issue link once one exists.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): deployment/production-config — how to configure wheels for prod
Covers config/environment.cfm + settings.cfm production overrides, env-var
resolution via application.wo.env() (framework → .env file → JVM env), the
auto-flips production applies (showErrorInformation=false, caching on,
autoMigrateDatabase=false), and a 10-item pre-boot checklist with source
anchors in the framework CFCs that enforce each item.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): deployment/docker-deployment — write a production dockerfile
Teaches packaging a wheels app as a docker image. Multi-stage dockerfile
(node builder + lucee/lucee:7-tomcat10-jre21 runtime), .dockerignore,
compose with redis sidecar and required-env guards, split /health + /ready
endpoints, image-size tips, multi-arch buildx, and Adobe/BoxLang base-image
swap hints. Explicit that wheels docker/wheels deploy do not exist in 4.0 —
readers use plain docker and docker compose CLIs.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): deployment/vm-deployment — lucee 7 on a linux vm
Covers lucee 7 + java 21 install, /opt/myapp/{current,releases,shared}
release layout, systemd unit (User=lucee, EnvironmentFile, Restart=on-failure),
nginx reverse proxy with TLS termination, and a zero-downtime rsync → migrate
→ ln -sfn swap sequence. CommandBox fallback noted for teams that prefer
box server. No fabricated wheels commands — plain ssh, rsync, systemctl.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): deployment/security-hardening — framework security primitives
Documents every header + setting in vendor/wheels/middleware/SecurityHeaders.cfc
with source line citations, the CSRF enforcement path (authenticityTokenField
→ $runCsrfProtection → $verifyAuthenticityToken), HSTS auto-default in
production, trusted proxy handling, reloadPassword rotation, and secret
management. Flags the missing HSTS off-switch as a known limitation linked
to issue #2174 rather than fabricating a non-existent parameter.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): deployment/observability — requestid, sentry, health checks
Covers the RequestId middleware (X-Request-Id, UUID per request), structured
logging patterns, a minimal Health controller with /healthz + /readyz split,
Sentry package activation (cp -r packages/sentry vendor/sentry) with what it
instruments and the known job-error gap, and external APM options (Datadog,
New Relic, OpenTelemetry) since wheels ships no first-party metrics.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): contributing/index — landing page for contributing & project
Explains project governance (core team via git log — no CODEOWNERS file yet),
the four ways to contribute (code, docs, packages, issue triage), and links
the existing CODE_OF_CONDUCT.md (Contributor Covenant v2.0). CardGrid to
pull-requests, coding-standards, writing-docs.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): contributing/pull-requests — fork, branch, test, submit
Step-by-step PR workflow. Cites commitlint.config.js directly for the valid
types + scope-enum (23 scopes spanning model, controller, view, router,
middleware, migration, cli, test, config, di, job, mailer, plugin, sse,
seed, docs, web, web/ui, web/landing, web/blog, web/guides, web/api,
web/starlight). Requires bash tools/test-local.sh before push.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): contributing/coding-standards — camelcase + cross-engine compat
Covers camelCase naming, component access modifiers (public for mixin
integration, $-prefix for internal scope), and the top cross-engine gotchas
from .ai/wheels/cross-engine-compatibility.md: struct.map() collision,
Adobe CF application scope, closure this, bracket-notation function calls
in closures, array-by-value in struct literals, createDynamicProxy Lucee
7 semantics, and the private mixin function trap.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): contributing/writing-docs — how to author a guide page
Walks a contributor through the docs workflow: frontmatter shapes (howto,
reference, section), Diátaxis typing, the three {test:*} directives sourced
from scripts/verify-docs/VALIDATION.md (compile, cli, tutorial), running
pnpm verify:docs + pnpm build locally, and sidebar wiring via the version
JSON file. Close with the common mdx/cfml gotchas that trip up first-time
contributors.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): upgrading/index — landing with versioning policy
Framework version sourced from vendor/wheels/events/onapplicationstart.cfc
(application.\$wheels.version = 4.0.0). CHANGELOG.md header confirms
Keep-a-Changelog + SemVer. Release cadence described from actual git tag
history (no fabricated schedule). CardGrid to 3x-to-4x (critical) and
2x-to-3x (pointer).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): upgrading/3x-to-4x — the critical upgrade page
Documents every 3.x → 4.0 breaking change with CHANGELOG + PR citations:
CORS deny-all (#2039), HSTS production default (#2081), CSRF key required
(#2079, #2086), allowEnvironmentSwitchViaUrl production flip (#2076),
RateLimiter trustProxy=false (#2024, #2088), CSRF SameSite cookie (#2035),
wheels snippets → wheels code (#1852), wheels.Test → wheels.WheelsTest
(#1889), tests/specs/functions/ → functional/ (#1872), wirebox → wheelsdi
(#1888). Deprecations: plugins/ (#1995), paginationLinks (#1930),
RocketUnit (#1925), HTTP MCP endpoint. Removed: RocketUnit core, Railo
shim (#1987), server.cfc (#1902). Worked example of plugin → package
port with provides.mixins explicit opt-in.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): upgrading/2x-to-3x — pointer to v3 guides
Short pointer (~200 words). Directs readers to the frozen v3.0 guides for
the 2→3 hop and the sibling 3x-to-4x page for the second hop. Explains
why skipping intermediate upgrades is expensive: each major's breaking
changes assume the previous version's semantics.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): glossary — 45 terms harvested from phase 2a/2b pages
Alphabetized reference with one-sentence definitions and links back to
the guide page where each concept is fully explained. Curated from
core-concepts, basics, and digging-deeper pages. Terms cut as too
generic (Controller, View, Model standalone) or lacking a conceptual
anchor in Phase 2a/2b (Mailer, WheelsTest, Strong params). Automation
deferred to a later polish pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): sidebar — wire phase 2c pages into v4 nav
Populates three previously-empty sidebar groups with the new Phase 2c
pages: Deployment & Operations (5 child items), Contributing & Project
(3 child items), Upgrading (2 child items). Glossary entry unchanged —
it's already a single-link row.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): .ai/ audit — delete files superseded by phase 2c
Phase 2c deployment/production-config.mdx and deployment/security-hardening.mdx
now cover the same territory with cited source anchors. Kept
.ai/wheels/security/https-detection.md (scoped to the isSecure() controller
helper, not deployment configuration) and .ai/wheels/cross-engine-compatibility.md
(contributor-facing reference used by contributing/coding-standards.mdx).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(docs): phase 2c completion report
16 commits, 14 content pages (6 deployment + 4 contributing + 3 upgrading
+ 1 glossary rewrite), sidebar wired, 2 .ai/ files retired. Final build
green at 340 pages; verify:docs green at 43/43 tagged blocks. Per-page
drift captured with source-verification wins and six carryover items
for follow-up work.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(docs): address phase 2c final review findings
Three findings from pr-review-toolkit:code-reviewer:
1. upgrading/3x-to-4x.mdx — removed fabricated SecurityHeaders(hsts=false)
API call. vendor/wheels/middleware/SecurityHeaders.cfc has no hsts boolean;
real parameter is strictTransportSecurity (string), and empty string
auto-falls-back to the production default. Page now honestly notes the
off-switch gap (#2174) with a "strip at your reverse proxy" workaround.
2. deployment/docker-deployment.mdx — fixed broken LinkCard href from
core-concepts/middleware/ (no such page) to core-concepts/middleware-pipeline/.
3. contributing/coding-standards.mdx — replaced broken LinkCard href pointing
at non-existent troubleshooting/cross-engine-compatibility/ with a link
to contributing/pull-requests (sibling page).
Build + verify:docs green.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(docs): vm-deployment — correct github org + branch in dockerfile link
Legacy `cfwheels/cfwheels` org and `main` branch — the repo is
`wheels-dev/wheels` and the default branch is `develop`.
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 455138f commit 8d32b2c
19 files changed
Lines changed: 3222 additions & 584 deletions
File tree
- .ai/wheels
- configuration
- security
- docs/superpowers/plans
- web/sites/guides/src
- content/docs/v4-0-0-snapshot
- contributing
- deployment
- upgrading
- sidebars
This file was deleted.
This file was deleted.
Lines changed: 112 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
0 commit comments