docs: add ONBOARDING.md engineering onboarding guide#36114
Conversation
Add a consolidated ONBOARDING.md at the repo root as the Engineering department's onboarding entry point, designed to be opened in Claude Code. Complements CLAUDE.md and merges still-useful content from dotBackendOnboarding.md and dotFrontendOnboarding.md, correcting stale versions to the current stack (Java 25, Node 22.15+, Angular 19+). Excludes dotCMS Utilities and license setup. Team-specific values (Slack channels, CODEOWNERS, doc links, CI/merge-queue rules) remain as placeholders for the owning team to fill in. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Claude finished @nollymar's task in 1m 33s —— View job Code Review — ONBOARDING.md
Overall: The structure is solid and the intent is right. A few concrete issues to fix before merging. Issues that need fixing1. just dev-start-on-port 8080 # default port is 8082 if omitted; `just dev-start` picks a random portThere is no 2. just test-postman ai # a single collection (recommended)
just test-postman all # all collections (slower)The actual justfile recipe is ./mvnw verify -pl :dotcms-postman -Dpostman.test.skip=false -Dpostman.collections=allThe 3. Feature-flag example uses a non-existent flag (ONBOARDING.md line 225) DOT_FEATURE_FLAG_SEO_IMPROVEMENTS: true
Minor concerns4. The guide presents 5.
6. just dev-start-on-port 8080 # ...
just dev-stop
just dev-run # run with Glowroot profiler
These do not block the draft phase, but items 1–3 should be fixed before un-drafting since they'll mislead anyone who tries to follow the guide. |
What
Adds a consolidated
ONBOARDING.mdat the repo root — the Engineering department's onboarding entry point, designed to be opened in Claude Code.Closes #36113
Why
We had two partially-overlapping, stale onboarding docs (
dotBackendOnboarding.md,dotFrontendOnboarding.md) pinned to old versions (Node 18, Angular 18, PrimeNG 17, Nx 19). This consolidates the still-useful content into one current guide that complementsCLAUDE.mdinstead of duplicating it.What's in it
sdk env install/nvm use,justcommands, Docker-by-default, recommended IDEs, an enterprise proxy/network section, and the Apple Silicon / Puppeteer Chromium fixcom.dotcms.*(modern) vscom.dotmarketing.*(legacy); backend vs frontend build worldsopenapi.yaml,Config/Logger, REST@SchemaVersions corrected throughout to Java 25, Node 22.15+, Angular 19+.
Intentionally excluded
Not ready for review — TODO before un-drafting
This PR is a draft. Team-specific
<<PLACEHOLDER>>values still need to be filled in by the owning team:dotBackendOnboarding.md/dotFrontendOnboarding.md🤖 Generated with Claude Code