cacti icon indicating copy to clipboard operation
cacti copied to clipboard

docs(vscode): high level devcontainer quickstart documentation

Open TonyRowntree opened this issue 4 years ago • 5 comments

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 avatar Apr 27 '21 12:04 TonyRowntree

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

davidkhala avatar Jun 15 '21 09:06 davidkhala

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.

TonyRowntree avatar Jun 15 '21 10:06 TonyRowntree

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?

davidkhala avatar Jun 17 '21 05:06 davidkhala

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.

TonyRowntree avatar Jun 17 '21 08:06 TonyRowntree

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)

petermetz avatar Jun 21 '21 23:06 petermetz

@jagpreetsinghsasan I would like to work on this issue!

musicboy0322 avatar Apr 15 '25 06:04 musicboy0322