From 73be9ec366a231875141388c3040f1e832b58767 Mon Sep 17 00:00:00 2001 From: Prajyot-Parab Date: Fri, 18 Aug 2023 13:49:38 +0530 Subject: [PATCH] Restructure dependency page for better readability Signed-off-by: Prajyot-Parab --- docs/book/src/developer/dependencies.md | 36 ++++++++++++++++++++----- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/docs/book/src/developer/dependencies.md b/docs/book/src/developer/dependencies.md index f91d744e53..5aba79ee95 100644 --- a/docs/book/src/developer/dependencies.md +++ b/docs/book/src/developer/dependencies.md @@ -1,19 +1,25 @@ # Modules and tools dependencies -| Package | Module name | Used by | -| --- | ----------- | ------- | +#### CAPI Packages +| Package | Module name | Used by | +| ------- | ----------- | ------- | | cluster-api | [sigs.k8s.io/cluster-api](https://github.com/kubernetes-sigs/cluster-api) | [go.mod][go.mod1] | | cluster-api/test | [sigs.k8s.io/cluster-api/test](https://github.com/kubernetes-sigs/cluster-api/tree/main/test) | [go.mod][go.mod1] | | cluster-api/hack/tools | [sigs.k8s.io/cluster-api/hack/tools](https://github.com/kubernetes-sigs/cluster-api/tree/main/hack/tools) | [hack/tools/go.mod][go.mod2] | -| controller-runtime | [sigs.k8s.io/controller-runtime](https://sigs.k8s.io/controller-runtime) | [go.mod][go.mod1] | -| controller-runtime/tools/setup-envtest | [sigs.k8s.io/controller-runtime/tools/setup-envtest](https://sigs.k8s.io/controller-runtime/tools/setup-envtest) | [hack/tools/go.mod][go.mod2] | -| controller-tools | [sigs.k8s.io/controller-tools](https://sigs.k8s.io/controller-tools) | [hack/tools/go.mod][go.mod2] | + +> Note: The K8s, Controller and Test packages are subject to updates with each new CAPI package release. + +#### IBM Packages +| Package | Module name | Used by | +| ------- | ----------- | ------- | | IBM-Cloud/power-go-client | [github.com/IBM-Cloud/power-go-client](https://github.com/IBM-Cloud/power-go-client) | [go.mod][go.mod1] | | IBM/go-sdk-core/v5 | [github.com/IBM/go-sdk-core/v5](https://github.com/IBM/go-sdk-core) | [go.mod][go.mod1] | | IBM/platform-services-go-sdk | [github.com/IBM/platform-services-go-sdk](https://github.com/IBM/platform-services-go-sdk) | [go.mod][go.mod1] | | IBM/vpc-go-sdk | [github.com/IBM/vpc-go-sdk](https://github.com/IBM/vpc-go-sdk) | [go.mod][go.mod1] | -| onsi/ginkgo/v2 | [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) | [go.mod][go.mod1] [hack/tools/go.mod][go.mod2] | -| onsi/gomega | [github.com/onsi/gomega](https://github.com/onsi/gomega) | [go.mod][go.mod1] | + +#### K8s Packages +| Package | Module name | Used by | +| ------- | ----------- | ------- | | api | [k8s.io/api](https://k8s.io/api) | [go.mod][go.mod1] | | apiextensions-apiserver | [k8s.io/apiextensions-apiserver](https://k8s.io/apiextensions-apiserver) | [go.mod][go.mod1] | | apimachinery | [k8s.io/apimachinery](https://k8s.io/apimachinery) | [go.mod][go.mod1] | @@ -21,6 +27,22 @@ | client-go | [k8s.io/client-go](https://k8s.io/client-go) | [go.mod][go.mod1] | | utils | [k8s.io/utils](https://k8s.io/utils) | [go.mod][go.mod1] | +#### Controller Packages +| Package | Module name | Used by | +| ------- | ----------- | ------- | +| controller-runtime | [sigs.k8s.io/controller-runtime](https://sigs.k8s.io/controller-runtime) | [go.mod][go.mod1] | +| controller-runtime/tools/setup-envtest | [sigs.k8s.io/controller-runtime/tools/setup-envtest](https://sigs.k8s.io/controller-runtime/tools/setup-envtest) | [hack/tools/go.mod][go.mod2] | +| controller-tools | [sigs.k8s.io/controller-tools](https://sigs.k8s.io/controller-tools) | [hack/tools/go.mod][go.mod2] | + +#### Test Packages +| Package | Module name | Used by | +| ------- | ----------- | ------- | +| onsi/ginkgo/v2 | [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) | [go.mod][go.mod1] [hack/tools/go.mod][go.mod2] | +| onsi/gomega | [github.com/onsi/gomega](https://github.com/onsi/gomega) | [go.mod][go.mod1] | + +
+ +--- #### Tools used by E2E tests. | Package | Used by | GitHub |