diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1887afadb..ad6a1496a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Guidelines on how to contribute to KubeSlice -There are a number of ways you can contribute to the KubeSlice project. We would like to accept your patches and contributions to the KubeSlice code base. This document provides guidelines on how to contribute to the KubeSlice code base. We require all participants to adhere to the [Code of Conduct](https://github.com/kubeslice/worker-operator/blob/doc/contributing-guide/code_of_conduct.md). +There are a number of ways you can contribute to the KubeSlice project. We would like to accept your patches and contributions to the KubeSlice code base. This document provides guidelines on how to contribute to the KubeSlice code base. We require all participants to adhere to the [Code of Conduct](code_of_conduct.md). Here are some ways to contribute: @@ -26,7 +26,7 @@ A signed commit is a commit where the commit message contains the following cont This can be done by adding `--signoff` to your git command line ## Code of Conduct -Please make sure to read and observe our [Code of Conduct](https://github.com/kubeslice/worker-operator/blob/doc/contributing-guide/code_of_conduct.md). +Please make sure to read and observe our [Code of Conduct](code_of_conduct.md). ## Contributor Workflow @@ -45,11 +45,11 @@ If you encounter a bug, please file an issue in the Github repository. Please pr ## Coding Guidelines -* Follow good [coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments). +* Follow good [coding guidelines](https://go.dev/wiki/CodeReviewComments). * Write good [commit messages](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). ## Developer Guide -This guide helps you to get started with developing [kubeslice-worker](https://github.com/kubeslice/worker-operator/blob/doc/contributing-guide/developer_guide.md). +This guide helps you to get started with developing [kubeslice-worker](developer_guide.md). ## License Apache License 2.0 diff --git a/developer_guide.md b/developer_guide.md index 731e5c55e..19ff42fab 100644 --- a/developer_guide.md +++ b/developer_guide.md @@ -1,10 +1,10 @@ # Development guidelines for KubeSlice Worker The KubeSlice-worker operator manages the life cycle of KubeSlice worker cluster related [CRDs](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/). -It is strongly recommended to use a released version. Follow the instructions provided in this [guide](https://docs.avesha.io/opensource/registering-the-worker-cluster#Bookmark162). +It is strongly recommended to use a released version. Follow the instructions provided in this [guide](https://docs.avesha.io/documentation/open-source/latest/install-kubeslice/kubeslice-cli/install-kubeslice/). ## Building and Installing `kubeslice-worker` in a Local Kind Cluster -For more information, see [getting started with kind clusters](https://docs.avesha.io/opensource/getting-started-with-kind-clusters). +For more information, see [getting started with kind clusters](https://docs.avesha.io/documentation/open-source/latest/category/get-started/). ### Setting up Development Environment @@ -82,7 +82,7 @@ make test ### Uninstalling the kubeslice-worker -Refer to the [uninstall guide](https://docs.avesha.io/opensource/uninstalling-kubeslice) +Refer to the [uninstall guide](https://docs.avesha.io/documentation/open-source/latest/uninstall-kubeslice/) 1. [Detach](https://docs.avesha.io/opensource/detaching-the-applications) the application from the slice.