From d69a9c4862e9cd5f73821690dd94ffc41ed94412 Mon Sep 17 00:00:00 2001 From: Nick Volynkin Date: Wed, 9 Apr 2025 11:00:28 +0300 Subject: [PATCH] [docs] Proofread the readme and contributing Fix a few errors here and there. Signed-off-by: Nick Volynkin --- CONTRIBUTING.md | 12 ++++++------ README.md | 33 +++++++++++++++++---------------- 2 files changed, 23 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95d3be0e..d0eb9b94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,13 +6,13 @@ As you get started, you are in the best position to give us feedbacks on areas o * Problems found while setting up the development environment * Gaps in our documentation -* Bugs in our Github actions +* Bugs in our GitHub actions -First, though, it is important that you read the [code of conduct](CODE_OF_CONDUCT.md). +First, though, it is important that you read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). The guidelines below are a starting point. We don't want to limit your creativity, passion, and initiative. If you think there's a better way, please -feel free to bring it up in a Github discussion, or open a pull request. We're +feel free to bring it up in a GitHub discussion, or open a pull request. We're certain there are always better ways to do things, we just need to start some constructive dialogue! @@ -23,9 +23,9 @@ We welcome many types of contributions including: * New features * Builds, CI/CD * Bug fixes -* [Documentation](https://github.com/cozystack/cozystack-website/tree/main) +* [Documentation](https://GitHub.com/cozystack/cozystack-website/tree/main) * Issue Triage -* Answering questions on Slack or Github Discussions +* Answering questions on Slack or GitHub Discussions * Web design * Communications / Social Media / Blog Posts * Events participation @@ -34,7 +34,7 @@ We welcome many types of contributions including: ## Ask for Help The best way to reach us with a question when contributing is to drop a line in -our [Telegram channel](https://t.me/cozystack), or start a new Github discussion. +our [Telegram channel](https://t.me/cozystack), or start a new GitHub discussion. ## Raising Issues diff --git a/README.md b/README.md index ddb8bdc4..d47123fd 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,21 @@ **Cozystack** is a free PaaS platform and framework for building clouds. -With Cozystack, you can transform your bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease. +With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, +Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease. -You can use Cozystack to build your own cloud or to provide a cost-effective development environments. +Use Cozystack to build your own cloud or provide a cost-effective development environment. ## Use-Cases -* [**Using Cozystack to build public cloud**](https://cozystack.io/docs/guides/use-cases/public-cloud/) -You can use Cozystack as backend for a public cloud +* [**Using Cozystack to build a public cloud**](https://cozystack.io/docs/guides/use-cases/public-cloud/) +You can use Cozystack as a backend for a public cloud -* [**Using Cozystack to build private cloud**](https://cozystack.io/docs/guides/use-cases/private-cloud/) -You can use Cozystack as platform to build a private cloud powered by Infrastructure-as-Code approach +* [**Using Cozystack to build a private cloud**](https://cozystack.io/docs/guides/use-cases/private-cloud/) +You can use Cozystack as a platform to build a private cloud powered by Infrastructure-as-Code approach -* [**Using Cozystack as Kubernetes distribution**](https://cozystack.io/docs/guides/use-cases/kubernetes-distribution/) -You can use Cozystack as Kubernetes distribution for Bare Metal +* [**Using Cozystack as a Kubernetes distribution**](https://cozystack.io/docs/guides/use-cases/kubernetes-distribution/) +You can use Cozystack as a Kubernetes distribution for Bare Metal ## Screenshot @@ -33,11 +34,11 @@ You can use Cozystack as Kubernetes distribution for Bare Metal ## Documentation -The documentation is located on official [cozystack.io](https://cozystack.io) website. +The documentation is located on the [cozystack.io](https://cozystack.io) website. -Read [Get Started](https://cozystack.io/docs/getting-started//) section for a quick start. +Read the [Getting Started](https://cozystack.io/docs/getting-started/) section for a quick start. -If you encounter any difficulties, start with the [troubleshooting guide](https://cozystack.io/docs/operations/troubleshooting/), and work your way through the process that we've outlined. +If you encounter any difficulties, start with the [troubleshooting guide](https://cozystack.io/docs/operations/troubleshooting/) and work your way through the process that we've outlined. ## Versioning @@ -50,15 +51,15 @@ A full list of the available releases is available in the GitHub repository's [R Contributions are highly appreciated and very welcomed! -In case of bugs, please, check if the issue has been already opened by checking the [GitHub Issues](https://github.com/cozystack/cozystack/issues) section. -In case it isn't, you can open a new one: a detailed report will help us to replicate it, assess it, and work on a fix. +In case of bugs, please check if the issue has already been opened by checking the [GitHub Issues](https://github.com/cozystack/cozystack/issues) section. +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. Commits are used to generate the changelog, and their author will be referenced in it. -In case of **Feature Requests** please use the [Discussion's Feature Request section](https://github.com/cozystack/cozystack/discussions/categories/feature-requests). +If you have **Feature Requests** please use the [Discussion's Feature Request section](https://github.com/cozystack/cozystack/discussions/categories/feature-requests). -You can join our weekly community meetings (just add this 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). +You are welcome to join our weekly community meetings (just add this 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). ## License