Skip to content

DX-D04: Update contributing setup documentation - #42

Open
w196n8y-hub wants to merge 1 commit into
thoth-tech:11.0.xfrom
ontrack-features-t2-2026:fix/dx-d04-clean
Open

DX-D04: Update contributing setup documentation#42
w196n8y-hub wants to merge 1 commit into
thoth-tech:11.0.xfrom
ontrack-features-t2-2026:fix/dx-d04-clean

Conversation

@w196n8y-hub

@w196n8y-hub w196n8y-hub commented Aug 27, 2026

Copy link
Copy Markdown

Summary

Updates CONTRIBUTING.md for DX-D04 to improve and simplify the development setup documentation.

Changes

  • Updated the frontend description from Angular/AngularJS to Angular 22.
  • Added Working with Dev Containers to the Table of Contents.
  • Added a shared Common setup section to remove duplicated setup instructions.
  • Updated the Dev Containers section to use the shared setup steps and identify Dev Containers as the primary development setup method.
  • Updated the Docker Compose section to use the shared setup steps.
  • Corrected outdated wording, spelling, and platform terminology, including VS Code and macOS.
  • Updated the Table of Contents to match the revised document structure.

Documentation reduction

The DX-D04 commit changes CONTRIBUTING.md by:

  • 39 additions
  • 53 deletions
  • Net reduction: 14 lines

Verified with:

git show --numstat --format= HEAD -- CONTRIBUTING.md

Validation

AngularJS reference check

Before the update, CONTRIBUTING.md contained an AngularJS reference.

Before:

git show HEAD^:CONTRIBUTING.md | grep -n "AngularJS"

After:

grep -n "AngularJS" CONTRIBUTING.md

Result: no AngularJS references remain in the updated document.

Clean checkout Dev Container validation

The Dev Container route was tested end-to-end from a clean checkout.

Validated repository combination:

  • API: 11.0.x
    • Commit: c6f1592c93961467b9766e67f0ff6154b03bd131
  • Web: 11.0.x
    • Commit: c97e793284b84683b149fd5da815c419cd7507ba
  • Deploy: fix/dx-d04-clean
    • Commit: 370d8128a509ad60d544cfd022a79e7bf2570ff5

Submodules were initialized with:

git submodule update --init --recursive

The deploy repository was then opened using the VS Code Dev Container route.

Verification inside the Dev Container:

  • Workspace opened successfully at /workspace.
  • git status --short returned no changes.
  • Web application at http://localhost:4200 returned HTTP/1.1 200 OK.
  • API endpoint at http://localhost:3000/api/settings returned HTTP 200.

Rendered documentation check

The rendered document was reviewed before and after the update.

Confirmed that:

  • Shared setup instructions are consolidated under Common setup.
  • Dev Containers now reference the shared Common setup.
  • Docker Compose also references the shared Common setup.
  • Both setup routes remain readable after removing duplicated instructions.

Repository note

The updated DX-D04 task references RUNNING-LOCALLY.md, but that file is not present in the current 11.0.x deploy repository. The existing repository documentation directs development setup through CONTRIBUTING.md, so the clean-checkout validation was completed using the Dev Container route documented there.

Evidence

Rendered documentation before

before

Rendered documentation after

after

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant