[docs] Update links, proofread the readme and contribution - #774
Conversation
WalkthroughThe changes include updates to several hyperlinks in the Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
21-21: Update Public Cloud Link and Suggest Wording AdjustmentThe updated link to
https://cozystack.io/docs/guides/use-cases/public-cloud/correctly reflects the new docs structure. As a minor nitpick, consider whether the title should read "Using Cozystack to build a public cloud" for improved grammatical flow, consistent with similar entries.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...se-Cases * [Using Cozystack to build public cloud](https://cozystack.io/docs/guid...(AI_EN_LECTOR_MISSING_DETERMINER_A)
24-24: Update Private Cloud Link and Optional Text RefinementThe link now points to
https://cozystack.io/docs/guides/use-cases/private-cloud/, aligning with the documentation restructure. Optionally, you might refine the title to "Using Cozystack to build a private cloud" if it fits the overall style guidelines.
27-27: Update Kubernetes Distribution Link and Consider Text ImprovementThe revised URL
https://cozystack.io/docs/guides/use-cases/kubernetes-distribution/correctly reflects the updated documentation path. Optionally, for clarity, consider revising the text to "Using Cozystack as a Kubernetes distribution" to include the article.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...se-Cases * [Using Cozystack to build public cloud](https://cozystack.io/docs/guid...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...blic-cloud/) You can use Cozystack as backend for a public cloud * [**Using Cozystac...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: pre-commit
🔇 Additional comments (1)
README.md (1)
40-40: Verify Troubleshooting Guide Link UpdateThe troubleshooting guide link has been correctly updated to
https://cozystack.io/docs/operations/troubleshooting/. This change accurately mirrors the restructuring of the docs.
| The documentation is located on official [cozystack.io](https://cozystack.io) website. | ||
|
|
||
| Read [Get Started](https://cozystack.io/docs/get-started/) section for a quick start. | ||
| Read [Get Started](https://cozystack.io/docs/getting-started//) section for a quick start. |
There was a problem hiding this comment.
Fix Double Slash in 'Get Started' URL
The "Get Started" link currently reads https://cozystack.io/docs/getting-started//, which contains an extra trailing slash that may affect routing. Please remove the extra slash as shown below:
-Read [Get Started](https://cozystack.io/docs/getting-started//) section for a quick start.
+Read [Get Started](https://cozystack.io/docs/getting-started/) section for a quick start.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Read [Get Started](https://cozystack.io/docs/getting-started//) section for a quick start. | |
| Read [Get Started](https://cozystack.io/docs/getting-started/) section for a quick start. |
c3ac6fd to
313449d
Compare
313449d to
9ac6370
Compare
Pre-commit checks used to trigger twice on PRs: for `push` and `pull_request` triggers. Now they will only run on `push` to the main branch and on regular updates to pull requests, except for those that only change the documentation. Note that pushes to feature branches will not trigger this check until a PR was opened. Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Follow-up to cozystack/website#138 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Fix a few errors here and there. Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
9ac6370 to
d69a9c4
Compare
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 2
🧹 Nitpick comments (3)
CONTRIBUTING.md (1)
15-16: Refine call-to-action phrasing.
The phrase “feel free to bring it up in a GitHub discussion, or open a pull request” could be reworded for a more formal tone. Consider something like “please raise your suggestions in a GitHub discussion or submit a pull request.”🧰 Tools
🪛 LanguageTool
[style] ~15-~15: ‘Bring it up’ can be overused. To elevate your writing, try opting for an alternative.
Context: ...ere's a better way, please feel free to bring it up in a GitHub discussion, or open a pull ...(BRING_THIS_UP)
README.md (2)
15-16: Enhance service description clarity.
The reworded lines now explain Cozystack’s capabilities more clearly. Consider further refining “a bunch of servers” to a more formal phrase (e.g., “multiple servers”) if a more professional tone is desired.
60-60: Enhance punctuation for clarity.
A comma after “Feature Requests” would improve the readability of the sentence. For example: “If you have Feature Requests, please use the Discussion's Feature Request section.”🧰 Tools
🪛 LanguageTool
[typographical] ~60-~60: It seems that a comma is missing.
Context: ...in it. If you have Feature Requests please use the [Discussion's Feature Request s...(IF_PLEASE_COMMA)
🛑 Comments failed to post (2)
README.md (2)
57-57:
⚠️ Potential issueFix grammatical error in contribution instructions.
The sentence “You can express your intention to on the fix on your own.” contains a grammatical error. Consider revising it to:- You can express your intention to on the fix on your own. + You can express your intention to work on the fix on your own.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.You can express your intention to work on the fix on your own.
62-62:
⚠️ Potential issueCorrect grammatical number agreement.
The phrase “just add this events to your [Google Calendar]…” should use “these” instead of “this” for correct number agreement. For example:- just add this events to your [Google Calendar] + just add these events to your [Google Calendar]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.You are welcome to join our weekly community meetings (just add these events to your [Google Calendar](https://calendar.google.com/calendar?cid=ZTQzZDIxZTVjOWI0NWE5NWYyOGM1ZDY0OWMyY2IxZTFmNDMzZTJlNjUzYjU2ZGJiZGE3NGNhMzA2ZjBkMGY2OEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) or [iCal](https://calendar.google.com/calendar/ical/e43d21e5c9b45a95f28c5d649c2cb1e1f433e2e653b56dbbda74ca306f0d0f68%40group.calendar.google.com/public/basic.ics)) or [Telegram group](https://t.me/cozystack).🧰 Tools
🪛 LanguageTool
[grammar] ~62-~62: The singular determiner ‘this’ may not agree with the plural noun ‘events’. Did you mean “these”?
Context: ...our weekly community meetings (just add this events to your [Google Calendar](https:...(THIS_NNS)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
CONTRIBUTING.md (1)
15-15: Suggestion: Rephrase "bring it up" for a More Formal ToneThe sentence "feel free to bring it up in a GitHub discussion, or open a pull request." could be made more formal. Consider rephrasing it to something like "please raise the matter in a GitHub discussion or open a pull request."
🧰 Tools
🪛 LanguageTool
[style] ~15-~15: ‘Bring it up’ can be overused. To elevate your writing, try opting for an alternative.
Context: ...ere's a better way, please feel free to bring it up in a GitHub discussion, or open a pull ...(BRING_THIS_UP)
README.md (3)
25-26: Link Update: Private Cloud Use-CaseThe private cloud link now correctly reflects the updated URL. Additionally, consider a minor grammatical refinement by inserting an "an" before "Infrastructure-as-Code approach" for smoother readability.
60-60: Punctuation Improvement: Insert Missing CommaIn the sentence "If you have Feature Requests please use the Discussion's Feature Request section," adding a comma after "Feature Requests" would enhance readability:
-If you have **Feature Requests** please use the ... +If you have **Feature Requests**, please use the ...🧰 Tools
🪛 LanguageTool
[typographical] ~60-~60: It seems that a comma is missing.
Context: ...in it. If you have Feature Requests please use the [Discussion's Feature Request s...(IF_PLEASE_COMMA)
62-62: Grammar Correction: Plural AgreementThe phrase "just add this events to your [Google Calendar]..." should use the plural form "these" to correctly agree with "events":
-just add this events to your [Google Calendar] +just add these events to your [Google Calendar]🧰 Tools
🪛 LanguageTool
[grammar] ~62-~62: The singular determiner ‘this’ may not agree with the plural noun ‘events’. Did you mean “these”?
Context: ...our weekly community meetings (just add this events to your [Google Calendar](https:...(THIS_NNS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.github/workflows/pre-commit.yml(1 hunks)CONTRIBUTING.md(3 hunks)README.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/workflows/pre-commit.yml
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~15-~15: ‘Bring it up’ can be overused. To elevate your writing, try opting for an alternative.
Context: ...ere's a better way, please feel free to bring it up in a GitHub discussion, or open a pull ...
(BRING_THIS_UP)
README.md
[typographical] ~60-~60: It seems that a comma is missing.
Context: ...in it. If you have Feature Requests please use the [Discussion's Feature Request s...
(IF_PLEASE_COMMA)
[grammar] ~62-~62: The singular determiner ‘this’ may not agree with the plural noun ‘events’. Did you mean “these”?
Context: ...our weekly community meetings (just add this events to your [Google Calendar](https:...
(THIS_NNS)
🔇 Additional comments (10)
CONTRIBUTING.md (2)
9-9: Clean Update: Correct Capitalization in Bullet ItemThe bullet "* Bugs in our GitHub actions" now correctly capitalizes "GitHub," ensuring consistency with the platform's branding.
11-11: Improved Reference: CNCF Code of ConductThe updated reference to the CNCF Code of Conduct clearly directs contributors to the appropriate document.
README.md (8)
15-16: Clarity Improvement: Expanded Description of CapabilitiesThe updated sentences now clearly articulate Cozystack’s ability to transform servers into an intelligent system with various services (e.g., Kubernetes clusters, Database-as-a-Service, etc.). This enhanced description improves the understanding of Cozystack's functionalities.
18-18: Verification: Cloud and Environment OfferingThe sentence "Use Cozystack to build your own cloud or provide a cost-effective development environment." is clear and concise.
22-23: Link & Description Update: Public Cloud Use-CaseThe link update for the public cloud use-case now points to the new documentation structure and the accompanying description is succinct.
28-29: Link Update: Kubernetes Distribution Use-CaseThe revised link for the Kubernetes distribution use-case is correct. The description clearly indicates its applicability for Bare Metal setups.
37-37: Documentation Reference UpdateThe statement "The documentation is located on the cozystack.io website." accurately reflects the current documentation location.
39-39: Link Update: Getting Started SectionThe "Getting Started" link has been correctly updated to the new URL. This will help new users easily find the introductory guide.
41-41: Link Update: Troubleshooting GuideThe troubleshooting guide link now points to the correct URL, ensuring that users have access to the updated operational guidance.
54-55: Process Clarification: Bug Reporting InstructionsThe instructions for checking existing GitHub Issues and reporting bugs are clearly stated and provide a well-defined process.
| If it isn't, you can open a new one. A detailed report will help us replicate it, assess it, and work on a fix. | ||
|
|
||
| You can express your intention in working on the fix on your own. | ||
| You can express your intention to on the fix on your own. |
There was a problem hiding this comment.
Grammar Correction Needed: Clarify Expression of Intent
The sentence "You can express your intention to on the fix on your own." is unclear. Consider rephrasing it as:
-You can express your intention to on the fix on your own.
+You can indicate your intention to work on the fix yourself.This revision improves clarity.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can express your intention to on the fix on your own. | |
| You can indicate your intention to work on the fix yourself. |
[docs] Update links after restructuring docs
Follow-up to Restructure Cozystack documentation website#138
[docs] Proofread the readme and contributing
Fix a few errors here and there.
[ci] Run pre-commit checks once on PRs
Pre-commit checks used to trigger twice on PRs: for
pushandpull_requesttriggers. Now they will only run on
pushto the main branch and on regularupdates to pull requests, except for those that only change the documentation.
Note that pushes to feature branches will not trigger this check until
a PR was opened.
Summary by CodeRabbit