DX-D04: Update contributing setup documentation - #42
Open
w196n8y-hub wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates
CONTRIBUTING.mdfor DX-D04 to improve and simplify the development setup documentation.Changes
Working with Dev Containersto the Table of Contents.Common setupsection to remove duplicated setup instructions.VS CodeandmacOS.Documentation reduction
The DX-D04 commit changes
CONTRIBUTING.mdby:Verified with:
git show --numstat --format= HEAD -- CONTRIBUTING.mdValidation
AngularJS reference check
Before the update,
CONTRIBUTING.mdcontained an AngularJS reference.Before:
git show HEAD^:CONTRIBUTING.md | grep -n "AngularJS"After:
grep -n "AngularJS" CONTRIBUTING.mdResult: 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:
11.0.xc6f1592c93961467b9766e67f0ff6154b03bd13111.0.xc97e793284b84683b149fd5da815c419cd7507bafix/dx-d04-clean370d8128a509ad60d544cfd022a79e7bf2570ff5Submodules were initialized with:
git submodule update --init --recursiveThe deploy repository was then opened using the VS Code Dev Container route.
Verification inside the Dev Container:
/workspace.git status --shortreturned no changes.http://localhost:4200returnedHTTP/1.1 200 OK.http://localhost:3000/api/settingsreturned HTTP200.Rendered documentation check
The rendered document was reviewed before and after the update.
Confirmed that:
Common setup.Common setup.Common setup.Repository note
The updated DX-D04 task references
RUNNING-LOCALLY.md, but that file is not present in the current11.0.xdeploy repository. The existing repository documentation directs development setup throughCONTRIBUTING.md, so the clean-checkout validation was completed using the Dev Container route documented there.Evidence
Rendered documentation before
Rendered documentation after