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 54s —— View job Rollback-Safety Analysis
Result: ✅ Safe to Rollback All changes in this PR are documentation-only:
No database migrations ( Label |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🤖 Bedrock Review —
|
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🤖 Bedrock Review —
|
… 21, Nx 22) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🤖 Bedrock Review —
|
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🤖 Bedrock Review —
|
|
Tick the box to add this pull request to the merge queue (same as
|
- §6: add one-time GPG commit signing step (link to GPG_COMMIT_SIGNING.md) - §3: add Karate API tests alongside Postman - §5: explain what a starter is, deployment options, and Artifactory link Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🤖 dotBot Review (Bedrock)Reviewed 3 file(s); 2 candidate(s) → 2 confirmed, 0 uncertain (unverified, kept for review). Confirmed findings
us.deepseek.r1-v1:0 · Run: #28695902040 · tokens: in: 19632 · out: 5517 · total: 25149 · calls: 6 · est. ~$0.056 |
| - **UI Components**: PrimeNG 17.18.11, PrimeFlex 3.3.1 | ||
| - **State Management**: NgRx Signals, Component Store | ||
| - **Build Tool**: Nx 19.6.5 | ||
| - **Angular**: 21.2.4 with standalone components and signals |
There was a problem hiding this comment.
🟠 [High] Angular version mismatch in documentation
The PR description specifies updating to Angular 19+, but the diff shows Angular 21.2.4 in dotFrontendOnboarding.md. This creates a discrepancy that could mislead developers about the actual Angular version required. The 3 major version difference (19 vs 21) suggests either a documentation error or versioning mistake that needs resolution.
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, and links back to the two discipline-specific guides for deeper detail.What's in it
sdk env install/nvm use,justcommands, Docker-by-default, recommended IDEs, and the Apple Silicon / Puppeteer Chromium fixcom.dotcms.*(modern) vscom.dotmarketing.*(legacy); backend vs frontend build worldsopenapi.yaml,Config/Logger, REST@SchemaDOT_prefix,FeatureFlagName.javareference), JSP/Tomcat mounting, language overrides#eng,#eng-adrs,#be-code-review,#guild-*,#feat-*,#team-*); everything else points to the How we do Engineering docVersions corrected throughout to Java 25, Node 22.15+, Angular 19+.
Also links to the discipline-specific
dotFrontendOnboarding.mdanddotBackendOnboarding.mdguides.Intentionally excluded
Status
All team-specific placeholders have been filled in — no
<<PLACEHOLDER>>values remain. Ready for review.Remaining follow-up (not blocking):
dotBackendOnboarding.md/dotFrontendOnboarding.md🤖 Generated with Claude Code