Skip to content
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

[chore][docs] enable Markdown lint rule MD024 #3104

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[chore][docs] enable Markdown lint rule MD024 #3104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion .markdownlint.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
default: true

MD013: false
MD024: false
MD050: false
MD052: false
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD024 -->
# Change Log

All notable changes to this project will be documented in this file.
Expand Down
16 changes: 7 additions & 9 deletions ray-operator/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ export GOROOT=$(go1.23.2 env GOROOT)
export PATH="$GOROOT/bin:$PATH"
```

## Development
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this header and shift the relevant ones below by one


### IDE Setup (VS Code)
## IDE Setup (VS Code)

* Step 1: Install the [VS Code Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go).
* Step 2: Import the KubeRay workspace configuration by using the file `kuberay.code-workspace` in the root of the KubeRay git repo:
Expand All @@ -47,7 +45,7 @@ All the following guidance require you to switch your working directory to the `
cd ray-operator
```

### Cleanup local binaries, such as controller-gen and kustomize
## Cleanup local binaries, such as controller-gen and kustomize

To keep consistent results of code generation and testing, you need to remove outdated binaries installed by the Makefile.

Expand All @@ -57,9 +55,9 @@ rm -rf bin
make clean
```

### End-to-end local development process on Kind
## End-to-end local development process on Kind

#### Run the operator inside the cluster
### Run the operator inside the cluster

```bash
# Step 1: Create a Kind cluster
Expand Down Expand Up @@ -100,7 +98,7 @@ kubectl logs {YOUR_OPERATOR_POD} | grep "Hello KubeRay"
* The command `make docker-build` (Step 3) will also run `make test` (unit tests).
* Step 6 also installs the custom resource definitions (CRDs) used by the KubeRay operator.

#### Run the operator outside the cluster
### Run the operator outside the cluster

> Note: Running the operator outside the cluster allows you to debug the operator using your IDE. For example, you can set breakpoints in the code and inspect the state of the operator.

Expand All @@ -118,7 +116,7 @@ make -C ray-operator build
./ray-operator/bin/manager -leader-election-namespace default -use-kubernetes-proxy
```

### Running the tests
## Running the tests

The unit tests can be run by executing the following command:

Expand Down Expand Up @@ -187,7 +185,7 @@ If not set, it defaults to a temporary directory that's removed once the tests e

Alternatively, You can run the e2e test(s) from your preferred IDE / debugger.

### Manually test new image in running cluster
## Manually test new image in running cluster

Build and apply the CRD:

Expand Down
Loading