docs(vscode): high level devcontainer quickstart documentation #3723
Conversation
This file contains 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
zondervancalvez
requested review from
petermetz,
takeutak,
izuru0,
jagpreetsinghsasan,
VRamakrishna,
sandeepnRES and
outSH
as code owners
jagpreetsinghsasan
requested changes
Jan 28, 2025
BUILD.md
Outdated
| @@ -40,6 +41,39 @@ The `npm run watch` script in action: | |||
|
|
|||
| ## Getting Started | |||
|
|
|||
| ### Quickstart with VSC Devcontainer for Hyperledger Cactus | |||
|
|
|||
| * Opening the Repo Within a Docker Container | |||
There was a problem hiding this comment.
Please make 'R' small here (repo)
BUILD.md
Outdated
| * Opening the Repo Within a Docker Container | ||
| * Install Prerequisites: | ||
| * Visual Studio Code (VSC) | ||
| * Docker Desktop (ensure it's running) https://docs.docker.com/engine/install/ |
There was a problem hiding this comment.
A link to Docker Desktop should be present here instead of Docker Engine
BUILD.md
Outdated
| * Open in VSC and Reopen in Container: | ||
| * Launch VSC | ||
| * Open the cacti folder | ||
| * Press Ctrl+Shift+P → Select Reopen in Container. |
There was a problem hiding this comment.
Instead use this Press F1 and type "Dev Containers: Open Folder in Container.."
BUILD.md
Outdated
| * Press Ctrl+Shift+P → Select Reopen in Container. | ||
| * Wait for the Container Setup: | ||
| * The devcontainer will install all required dependencies inside the container. | ||
| * Cloning the Repo to a Docker Volume |
There was a problem hiding this comment.
From Line 62 to Line 72 is not required
There was a problem hiding this comment.
For showcasing how to run Cacti from a docker volume, create a sub-section instead stating how to attach the docker volume containing Hyperledger Cacti to the running VSC container
zondervancalvez
force-pushed
the
zondervancalvez/issue874
branch
3 times, most recently
from
5737283 to
136c65b
Compare
jagpreetsinghsasan
requested changes
Jan 28, 2025
Primary Changes ---------------- 1. Added a documentation describing how to get started by opening the repo within the docker container and by cloning the repo to a docker volume Fixes hyperledger-cacti#874 Signed-off-by: bado <[email protected]>
zondervancalvez
force-pushed
the
zondervancalvez/issue874
branch
from
136c65b to
ab03474
Compare
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.
Commit to be reviewed
docs(vscode): high level devcontainer quickstart documentation
Fixes #874
Pull Request Requirements
upstream/mainbranch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.-sflag when usinggit commitcommand. You may refer to this link for more information.Character Limit
A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.