Description
Add a single consolidated ONBOARDING.md at the repo root to serve as the Engineering department's onboarding entry point, designed to be opened in Claude Code.
It complements CLAUDE.md (does not duplicate it) and merges the still-useful content from the existing dotBackendOnboarding.md and dotFrontendOnboarding.md, while correcting stale versions to the current stack (Java 25, Node 22.15+, Angular 19+).
Covers:
- Day-one environment setup —
sdk env install / nvm use, just commands, Docker-by-default, recommended IDEs, an enterprise proxy/network section, and the Apple Silicon / Puppeteer Chromium fix
- Codebase mental model —
com.dotcms.* (modern) vs com.dotmarketing.* (legacy); backend vs frontend build worlds
- Fast testing workflows — targeted integration tests, the IDE loop, Postman, and Spectator conventions (never run the full suite)
- Repo landmines — BOM-only versions, auto-generated
openapi.yaml, Config/Logger rules, REST @Schema
- Local config — admin password, feature flags, JSP/Tomcat-root mounting, language overrides
- First-PR flow, available Claude Code skills, and a people/comms section
Excludes (intentionally): dotCMS Utilities and license setup.
Acceptance Criteria
Additional Context
Intended to be shareable department-wide via Claude Code's onboarding-guide feature. Several <<PLACEHOLDER>> markers remain by design for org-specific values that can't be derived from the repo. Delivered as a draft PR (not ready for review) pending those fill-ins.
Description
Add a single consolidated
ONBOARDING.mdat the repo root to serve as the Engineering department's onboarding entry point, designed to be opened in Claude Code.It complements
CLAUDE.md(does not duplicate it) and merges the still-useful content from the existingdotBackendOnboarding.mdanddotFrontendOnboarding.md, while correcting stale versions to the current stack (Java 25, Node 22.15+, Angular 19+).Covers:
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/Loggerrules, REST@SchemaExcludes (intentionally): dotCMS Utilities and license setup.
Acceptance Criteria
ONBOARDING.mdexists at the repo rootCLAUDE.mdand links to/docs/rather than duplicating contentAdditional Context
Intended to be shareable department-wide via Claude Code's onboarding-guide feature. Several
<<PLACEHOLDER>>markers remain by design for org-specific values that can't be derived from the repo. Delivered as a draft PR (not ready for review) pending those fill-ins.