Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(vscode): high level devcontainer quickstart documentation #874

Open
TonyRowntree opened this issue Apr 27, 2021 · 5 comments · May be fixed by #3723
Open

docs(vscode): high level devcontainer quickstart documentation #874

TonyRowntree opened this issue Apr 27, 2021 · 5 comments · May be fixed by #3723
Assignees
Labels
Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request

Comments

@TonyRowntree
Copy link
Contributor

Description

As a potential contributor to Hyperledger Cactus I would like some high level documentation describing how I can quickstart using the VSC devcontainer functionality.

Acceptance Criteria

  1. Documentation describing how to get started by opening the repo within the docker container
  2. Additional documentation describing how to get started by cloning the repo to a docker volume
  3. Documentation uploaded to any of the following - read the docs, BUILD.md or CONTRIBUTING.md

@petermetz @jonathan-m-hamilton @sfuji822 @takeutak @kikoncuo

@TonyRowntree TonyRowntree self-assigned this Jun 10, 2021
@davidkhala
Copy link

On the other side, is there any evitable reason that Cactus have to lock on VsCode?

@TonyRowntree
Copy link
Contributor Author

TonyRowntree commented Jun 15, 2021

Hi @davidkhala, no reason that I am aware of. Currently we have implemented the feature to quickstart development on the project using the VSCode docker in docker dev container solution. I am unaware of any SCE with this same feature.

@davidkhala
Copy link

Hi @davidkhala, no reason that I am aware of. Currently we have implemented the feature to quickstart development on the project using the VSCode docker in docker dev container solution. I am unaware of any SCE with this same feature.

So can we consider remove the .vscode directory? Or any impact after removing?

@TonyRowntree
Copy link
Contributor Author

So can we consider remove the .vscode directory? Or any impact after removing?

You can safely remove the .vscode directory with no impact. At the minute that folder only contains a file for recommended extensions and another file to tell vscode how to run the debugger.

@petermetz
Copy link
Contributor

On the other side, is there any evitable reason that Cactus have to lock on VsCode?

@davidkhala Similar thoughts here as per @TonyRowntree put it, I just wanted to add as an extra clarification that we are recommending VSCode, but definitely not locked on it, meaning that there isn't a hard dependency on VSCode or any other IDE for that matter. If one wishes to do so, they can get by with bash+vi just as well (of course some tasks will involve a little more typing)

@TonyRowntree TonyRowntree removed their assignment Aug 9, 2021
@petermetz petermetz added Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request labels Nov 3, 2021
zondervancalvez added a commit to zondervancalvez/cactus that referenced this issue Jan 15, 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 added a commit to zondervancalvez/cactus that referenced this issue 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 added a commit to zondervancalvez/cactus that referenced this issue 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 added a commit to zondervancalvez/cactus that referenced this issue 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 added a commit to zondervancalvez/cactus that referenced this issue 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants