docs: improve README clarity and add setup instructions#2391
docs: improve README clarity and add setup instructions#2391Akash-Adak wants to merge 2 commits intoopenkruise:masterfrom
Conversation
|
Welcome @Akash-Adak! It looks like this is your first PR to openkruise/kruise 🎉 |
There was a problem hiding this comment.
Pull request overview
Updates the project’s main README to improve onboarding/readability by restructuring the introduction and feature descriptions, and adding a basic “Quick Start” section with prerequisites and installation pointers.
Changes:
- Reworked the Introduction and Key Features sections for clearer, more consistent wording and formatting.
- Added Quick Start prerequisites plus a basic setup/installation section.
- Simplified Contributing and Community sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
README.md
Outdated
| * Slack: OpenKruise channel (Kubernetes Slack) | ||
| * Community meetings and discussions available in docs |
| ## Security | ||
| Please report vulnerabilities by email to kubernetes-security@service.aliyun.com. Also see our [SECURITY.md](SECURITY.md) file for details. | ||
| --- | ||
|
|
README.md
Outdated
| </a> | ||
| ```bash | ||
| kubectl apply -f https://raw.githubusercontent.com/openkruise/kruise/master/config/crd/bases/apps.kruise.io_clonesets.yaml | ||
| ```` |
README.md
Outdated
| ### Basic Setup Example | ||
|
|
||
| - install Kruise on a Serverless K8S cluster in 3 minutes, try: | ||
| Deploy OpenKruise CRDs: | ||
|
|
||
| <a href="https://acs.console.aliyun.com/quick-deploy?repo=openkruise/charts&branch=master&paths=%5B%22versions/kruise/1.8.0%22%5D" target="_blank"> | ||
| <img src="https://img.alicdn.com/imgextra/i1/O1CN01aiPSuA1Wiz7wkgF5u_!!6000000002823-55-tps-399-70.svg" width="200" alt="Deploy on Alibaba Cloud"> | ||
| </a> | ||
| ```bash | ||
| kubectl apply -f https://raw.githubusercontent.com/openkruise/kruise/master/config/crd/bases/apps.kruise.io_clonesets.yaml | ||
| ```` |
|
/assign @furykerry |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2391 +/- ##
=======================================
Coverage 48.77% 48.78%
=======================================
Files 324 324
Lines 27928 27928
=======================================
+ Hits 13623 13624 +1
- Misses 12775 12776 +1
+ Partials 1530 1528 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…structions Ⅰ. Describe what this PR does This PR improves the README documentation by fixing formatting issues, restoring missing sections, and enhancing clarity for new contributors. Key improvements include: - Fixed broken Markdown formatting (code blocks, headings, spacing) - Replaced incomplete CRD-only setup with proper Helm-based installation instructions - Restored and improved Community section with direct links - Added Security section with references to SECURITY.md and SECURITY_CONTACTS.md - Improved overall readability and structure of the README These changes make the project easier to understand and help new contributors get started more smoothly. Ⅱ. Does this pull request fix one issue? NONE Ⅲ. Describe how to verify it - Open README.md on GitHub - Verify that: - All sections render correctly (no broken Markdown) - Installation instructions are clear and complete (Helm-based) - Community links are clickable - Security section is present and correctly linked - Overall readability and structure are improved No code changes are involved. Ⅳ. Special notes for reviews This is a documentation-only improvement focused on better onboarding experience and readability.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @furykerry, I’ve addressed all review comments and updated the README accordingly. Could you please review again? 🙏 |
Ⅰ. Describe what this PR does
This PR improves the README by fixing formatting issues, enhancing clarity of the introduction and key sections, and adding basic setup instructions for beginners.
These changes make it easier for new contributors to understand and get started with OpenKruise.
Ⅱ. Does this pull request fix one issue?
NONE
Ⅲ. Describe how to verify it
Review the updated README.md file to check:
No code changes are involved.
Ⅳ. Special notes for reviews
This is a documentation-only improvement aimed at enhancing readability and onboarding experience for new contributors.