Skip to content

Commit df9d9c7

Browse files
authored
Update doc links (#3087)
1 parent 8163def commit df9d9c7

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

porch/docs/development.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,18 @@ make generate
1313
Porch comprises of several software components:
1414

1515
* [api](../api): Definition of the KRM API supported by the Porch extension apiserver
16-
* [apiserver](../apiserver): The Porch apiserver implementation, REST handlers, Porch `main` function
17-
* [engine](../engine): Core logic of Package Orchestration - operations on package contents
16+
* [apiserver](../pkg/apiserver/): The Porch apiserver implementation, REST handlers, Porch `main` function
17+
* [engine](../pkg/engine/): Core logic of Package Orchestration - operations on package contents
1818
* [func](../func): KRM function evaluator microservice; exposes gRPC API
19-
* [repository](../repository): Integration with Git and OCI package repositories, and package caching
19+
* [repository](../pkg/repository/): Repository integration packge
20+
* [git](../pkg/git/): Integration with Git repository.
21+
* [oci](../pkg/oci/): Integration with OCI repository.
22+
* [cache](../pkg/cache/): Package caching.
2023
* [controllers](../controllers): `Repository` CRD. No controller;
2124
Porch apiserver watches these resources for changes as repositories are (un-)registered.
2225
* [remoterootsync](../controllers/remoterootsync): CRD and controller for deploying packages
23-
* [test](../test): Test Git Server for Porch e2e testing
26+
* [test](../test): Test Git Server for Porch e2e testing, and
27+
[e2e](../test/e2e/) tests.
2428

2529
## Running Porch
2630

@@ -64,13 +68,13 @@ Update the launch arguments to your needs.
6468

6569
Some useful code pointers:
6670

67-
* Porch REST API handlers in [registry/porch](../apiserver/pkg/registry/porch), for example
68-
[packagerevision.go](../apiserver/pkg/registry/porch/packagerevision.go)
69-
* Background task handling cache updates in [background.go](../apiserver/pkg/registry/porch/background.go)
70-
* Git repository integration in [repository/pkg/git](../repository/pkg/git)
71-
* OCI repository integration in [repository/pkg/oci](../repository/pkg/oci)
72-
* CaD Engine in [engine](../engine/pkg/engine)
73-
* e2e tests in [e2e](../apiserver/pkg/e2e). See below more on testing.
71+
* Porch REST API handlers in [registry/porch](../pkg/registry/porch/), for example
72+
[packagerevision.go](../pkg/registry/porch/packagerevision.go)
73+
* Background task handling cache updates in [background.go](../pkg/registry/porch/background.go)
74+
* Git repository integration in [pkg/git](../pkg/git)
75+
* OCI repository integration in [pkg/oci](../pkg/oci)
76+
* CaD Engine in [engine](../pkg/engine)
77+
* e2e tests in [e2e](../test/e2e/). See below more on testing.
7478

7579
## Running Tests
7680

porch/docs/running-locally.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ make tidy
2929
## Running Porch
3030

3131
Porch consists of:
32-
* k8s extension apiserver [porch](../porch/apiserver)
33-
* kpt function evaluator [func](../porch/func)
34-
* k8s [controllers](../porch/controllers)
32+
* k8s extension apiserver [porch](../pkg/apiserver/)
33+
* kpt function evaluator [func](../func/)
34+
* k8s [controllers](../controllers)
3535

3636
In addition, to run Porch locally, we need to run the main k8s apiserver and its backing storage, etcd.
3737

0 commit comments

Comments
 (0)