Skip to content

Commit

Permalink
Removal of reference to the VSCode workspace file (#170)
Browse files Browse the repository at this point in the history
It was removed in nephio-project/porch#107

Signed-off-by: Gergely Csatari <[email protected]>
  • Loading branch information
CsatariGergely authored Sep 12, 2024
1 parent 5aa6a97 commit 8eb30c4
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions content/en/docs/porch/contributors-guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ make generate

Porch comprises of several software components:

* [api](https://github.com/nephio-project/porch/tree/main/api): Definition of the KRM API supported by the Porch extension apiserver
* [porchctl](https://github.com/nephio-project/porch/tree/main/cmd/porchctl): CLI command tool for administration of Porch `Repository` and `PackageRevision` custom resources.
* [apiserver](https://github.com/nephio-project/porch/tree/main/pkg/apiserver): The Porch apiserver implementation, REST handlers, Porch `main` function
* [engine](https://github.com/nephio-project/porch/tree/main/pkg/engine): Core logic of Package Orchestration - operations on package contents
* [api](https://github.com/nephio-project/porch/tree/main/api): Definition of the KRM API supported by the Porch
extension apiserver
* [porchctl](https://github.com/nephio-project/porch/tree/main/cmd/porchctl): CLI command tool for administration of
Porch `Repository` and `PackageRevision` custom resources.
* [apiserver](https://github.com/nephio-project/porch/tree/main/pkg/apiserver): The Porch apiserver implementation, REST
handlers, Porch `main` function
* [engine](https://github.com/nephio-project/porch/tree/main/pkg/engine): Core logic of Package Orchestration -
operations on package contents
* [func](https://github.com/nephio-project/porch/tree/main/func): KRM function evaluator microservice; exposes gRPC API
* [repository](https://github.com/nephio-project/porch/blob/main/pkg/repository): Repository integration package
* [git](https://github.com/nephio-project/porch/tree/main/pkg/git): Integration with Git repository.
Expand Down Expand Up @@ -108,6 +112,5 @@ then run test suite against the Porch instance.
## VSCode

[VSCode](https://code.visualstudio.com/) works really well for editing and debugging.
Because Porch is comprises of multiple go modules, there is a pre-configured
multi-folder workspace in [porch.code-workspace](https://github.com/nephio-project/porch/blob/main/porch.code-workspace).
Open it in VSCode (File / Open Workspace from File) to use Workspace Folders.
Just open VSCode from the root folder of the Porch repository and it will work fine. The folder contains the needed
configuration to Launch different functions of Proch.

0 comments on commit 8eb30c4

Please sign in to comment.