Skip to content

docs(): fix dead links and update obsolete URLs in contributor docs #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Maximus-08 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(): fix dead links and update obsolete URLs in contributor docs #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5469b2
docs: fix dead links and update obsolete URLs in contributor docs
Maximus-08 May 23, 2026
bcf55ee
fix: change docs version to latest
Maximus-08 May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

Expand All @@ -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
6 changes: 3 additions & 3 deletions developer_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.

Expand Down