From 7d115bc61ee4ddfcbbce7c90adf06af44ae0ecce Mon Sep 17 00:00:00 2001 From: kanchan-dhamane <74534570+kanchan-dhamane@users.noreply.github.com> Date: Thu, 11 Jul 2024 09:54:02 +0530 Subject: [PATCH] Add note for make reviewable in Prerequisites section of Code Contribution Guide Signed-off-by: kanchan-dhamane <74534570+kanchan-dhamane@users.noreply.github.com> --- docs/contributor/code-contribute.md | 5 ++++- versioned_docs/version-v1.7/contributor/code-contribute.md | 5 ++++- versioned_docs/version-v1.8/contributor/code-contribute.md | 5 ++++- versioned_docs/version-v1.9/contributor/code-contribute.md | 5 ++++- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/contributor/code-contribute.md b/docs/contributor/code-contribute.md index de3bf2c28e9..cfb576651e3 100644 --- a/docs/contributor/code-contribute.md +++ b/docs/contributor/code-contribute.md @@ -128,6 +128,9 @@ For other OS or system architecture, please refer to https://storage.googleapis. go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.6.2 go install golang.org/x/tools/cmd/goimports@latest ``` + :::caution + Note: For macOS, you may need to install [diffutils](https://www.gnu.org/software/diffutils/). + ::: :::tip You may also be interested with KubeVela's [design](https://github.com/oam-dev/kubevela/tree/master/design/vela-core) before diving into its code. @@ -493,4 +496,4 @@ To solve this issue, execute: ```bash go install golang.org/x/tools/cmd/goimports@latest -``` \ No newline at end of file +``` diff --git a/versioned_docs/version-v1.7/contributor/code-contribute.md b/versioned_docs/version-v1.7/contributor/code-contribute.md index 11fb9cfebf5..c0ebb9a01f5 100644 --- a/versioned_docs/version-v1.7/contributor/code-contribute.md +++ b/versioned_docs/version-v1.7/contributor/code-contribute.md @@ -127,6 +127,9 @@ For other OS or system architecture, please refer to https://storage.googleapis. go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.6.2 go install golang.org/x/tools/cmd/goimports@latest ``` + :::caution + Note: For macOS, you may need to install [diffutils](https://www.gnu.org/software/diffutils/). + ::: :::tip You may also be interested with KubeVela's [design](https://github.com/oam-dev/kubevela/tree/master/design/vela-core) before diving into its code. @@ -471,4 +474,4 @@ Learn how to write the docs by the following guide: * [kubevela.io Developer Guide](https://github.com/kubevela/kubevela.io/blob/main/README.md) * [Update KubeVela.io CLI Reference Doc](./cli-ref-doc.md) -Great, you have complete the lifecycle of code contribution, try to [join the community as a member](https://github.com/kubevela/community/blob/main/community-membership.md) if you're interested. \ No newline at end of file +Great, you have complete the lifecycle of code contribution, try to [join the community as a member](https://github.com/kubevela/community/blob/main/community-membership.md) if you're interested. diff --git a/versioned_docs/version-v1.8/contributor/code-contribute.md b/versioned_docs/version-v1.8/contributor/code-contribute.md index 11fb9cfebf5..c0ebb9a01f5 100644 --- a/versioned_docs/version-v1.8/contributor/code-contribute.md +++ b/versioned_docs/version-v1.8/contributor/code-contribute.md @@ -127,6 +127,9 @@ For other OS or system architecture, please refer to https://storage.googleapis. go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.6.2 go install golang.org/x/tools/cmd/goimports@latest ``` + :::caution + Note: For macOS, you may need to install [diffutils](https://www.gnu.org/software/diffutils/). + ::: :::tip You may also be interested with KubeVela's [design](https://github.com/oam-dev/kubevela/tree/master/design/vela-core) before diving into its code. @@ -471,4 +474,4 @@ Learn how to write the docs by the following guide: * [kubevela.io Developer Guide](https://github.com/kubevela/kubevela.io/blob/main/README.md) * [Update KubeVela.io CLI Reference Doc](./cli-ref-doc.md) -Great, you have complete the lifecycle of code contribution, try to [join the community as a member](https://github.com/kubevela/community/blob/main/community-membership.md) if you're interested. \ No newline at end of file +Great, you have complete the lifecycle of code contribution, try to [join the community as a member](https://github.com/kubevela/community/blob/main/community-membership.md) if you're interested. diff --git a/versioned_docs/version-v1.9/contributor/code-contribute.md b/versioned_docs/version-v1.9/contributor/code-contribute.md index de3bf2c28e9..cfb576651e3 100644 --- a/versioned_docs/version-v1.9/contributor/code-contribute.md +++ b/versioned_docs/version-v1.9/contributor/code-contribute.md @@ -128,6 +128,9 @@ For other OS or system architecture, please refer to https://storage.googleapis. go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.6.2 go install golang.org/x/tools/cmd/goimports@latest ``` + :::caution + Note: For macOS, you may need to install [diffutils](https://www.gnu.org/software/diffutils/). + ::: :::tip You may also be interested with KubeVela's [design](https://github.com/oam-dev/kubevela/tree/master/design/vela-core) before diving into its code. @@ -493,4 +496,4 @@ To solve this issue, execute: ```bash go install golang.org/x/tools/cmd/goimports@latest -``` \ No newline at end of file +```