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.

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 rules MD005 and MD007 #3073

Merged
merged 1 commit into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@

- [ ] I've made sure the tests are passing.
- Testing Strategy
- [ ] Unit tests
- [ ] Manual tests
- [ ] This PR is not tested :(
- [ ] Unit tests
- [ ] Manual tests
- [ ] This PR is not tested :(
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ The KubeRay 0.5.2 patch release includes the following improvements.
* Allow watching multiple namespaces
* [Feature] Watch CR in multiple namespaces with namespaced RBAC resources ([#1106](https://github.com/ray-project/kuberay/pull/1106), [@kevin85421](https://github.com/kevin85421))
* Autoscaler stability improvements
* [Bug] RayService restarts repeatedly with Autoscaler ([#1037](https://github.com/ray-project/kuberay/pull/1037), [@kevin85421](https://github.com/kevin85421))
* [Bug] RayService restarts repeatedly with Autoscaler ([#1037](https://github.com/ray-project/kuberay/pull/1037), [@kevin85421](https://github.com/kevin85421))
* [Bug] autoscaler not working properly in rayjob ([#1064](https://github.com/ray-project/kuberay/pull/1064), [@Yicheng-Lu-llll](https://github.com/Yicheng-Lu-llll))
* [Bug][Autoscaler] Operator does not remove workers ([#1139](https://github.com/ray-project/kuberay/pull/1139), [@kevin85421](https://github.com/kevin85421))

Expand Down
2 changes: 0 additions & 2 deletions ci/markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
# Default state for all rules
default: true

MD005: false
MD007: false
MD012: false
MD013: false
MD022: false
Expand Down
8 changes: 4 additions & 4 deletions docs/development/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ Bug fix pull requests to fix bugs which found in the documentation testing proce

Manual testing can be time-consuming, and to relieve the workload, we plan to add more CI tests. The minimum requirements to move forward are:

* All example configurations can work with `kuberay/operator:nightly` and the latest release of Ray (i.e. 2.3.0 for KubeRay v0.5.0).
* Update all version strings in the documents.
* All example configurations can work with `kuberay/operator:nightly` and the latest release of Ray (i.e. 2.3.0 for KubeRay v0.5.0).
* Update all version strings in the documents.

#### Step 2. Create a new branch in ray-project/kuberay repository

Expand Down Expand Up @@ -123,8 +123,8 @@ Now, we have the Docker images and Helm charts for v0.5.0.
#### Step 7. Update KubeRay documentation in Ray repository.
* Update KubeRay documentation in Ray repository with v0.5.0. Examples for v0.5.0:
* https://github.com/ray-project/ray/pull/33339
* https://github.com/ray-project/ray/pull/34178
* https://github.com/ray-project/ray/pull/33339
* https://github.com/ray-project/ray/pull/34178
#### Step 8. Generate release
Expand Down
8 changes: 4 additions & 4 deletions docs/guidance/rayclient-nginx-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ This document provides an example for connecting Ray client to a Raycluster via

# Requirements
* Environment:
* `Ubuntu`
* `Kind`
* `Ubuntu`
* `Kind`

* Computing resources:
* 16GB RAM
* 8 CPUs
* 16GB RAM
* 8 CPUs

## Step 1: Create a Kind cluster
The extra arg prepares the Kind cluster for deploying the ingress controller
Expand Down
Loading