Skip to content

Commit 7a4ac1d

Browse files
tym83claude
andcommitted
docs(readme): fix review findings
Reverted the <picture> element. #gh-light-mode-only keys off GitHub's account theme; prefers-color-scheme keys off the OS. They diverge for anyone who pins a GitHub theme rather than syncing with the system, and the combination 'OS dark, GitHub light' renders the white logo on white. The fragment form is correct in all four combinations. Kept the width attribute, which was the actual fix -- the logo stretched to 734px because the SVG has no intrinsic width, not because of the fragment. Also from review: - /docs/roadmap/ on the website is a 404; linked ROADMAP.md instead. - Added a project-documents table. The README linked one of the eight policy files in the repository root; governance, code of conduct, security policy and adopters are what a newcomer and a CNCF reviewer both look for first. - Added both Slack channels. The community section listed Telegram only, while the CNCF-hosted #cozystack channel went unmentioned. - Added the CLOMonitor badge, the standard CNCF project-health signal. It currently reports A. - semver.org was the one remaining plain-http link, which sat oddly next to dropping a badge for the same reason. - The commit-activity badge linked to the contributors graph. - 'free platform' reads as price now that the Open Source badge is gone. - 'CNCF Sandbox Level Project' is legacy phrasing. - Fixed an ungrammatical sentence in Contributions. Co-Authored-By: Claude <[email protected]> Signed-off-by: tym83 <[email protected]>
1 parent 34c7a20 commit 7a4ac1d

1 file changed

Lines changed: 22 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
<picture>
2-
<source media="(prefers-color-scheme: dark)" srcset="img/cozystack-logo-white.svg">
3-
<img src="img/cozystack-logo-black.svg" alt="Cozystack" width="340">
4-
</picture>
1+
<img src="img/cozystack-logo-black.svg#gh-light-mode-only" alt="Cozystack" width="340">
2+
<img src="img/cozystack-logo-white.svg#gh-dark-mode-only" alt="Cozystack" width="340">
53

64
[![GitHub Release](https://img.shields.io/github/release/cozystack/cozystack.svg?style=flat)](https://github.com/cozystack/cozystack/releases/latest)
75
[![Apache-2.0 License](https://img.shields.io/github/license/cozystack/cozystack)](https://github.com/cozystack/cozystack/blob/main/LICENSE)
8-
[![Commit activity](https://img.shields.io/github/commit-activity/y/cozystack/cozystack)](https://github.com/cozystack/cozystack/graphs/contributors)
6+
[![Commit activity](https://img.shields.io/github/commit-activity/y/cozystack/cozystack)](https://github.com/cozystack/cozystack/graphs/commit-activity)
97
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10177/badge)](https://www.bestpractices.dev/projects/10177)
108
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/cozystack/cozystack/badge)](https://securityscorecards.dev/viewer/?uri=github.com/cozystack/cozystack)
9+
[![CLOMonitor](https://img.shields.io/endpoint?url=https://clomonitor.io/api/projects/cncf/cozystack/badge)](https://clomonitor.io/projects/cncf/cozystack)
1110
[![Support](https://img.shields.io/badge/$-support-12a0df.svg?style=flat)](https://cozystack.io/support/)
1211

1312
# Cozystack
1413

15-
**Cozystack** is a free platform and framework for building clouds.
14+
**Cozystack** is a free and open-source platform and framework for building clouds.
1615

17-
Cozystack is a [CNCF Sandbox Level Project](https://www.cncf.io/sandbox-projects/) that was originally built and sponsored by [Ænix](https://aenix.io/).
16+
Cozystack is a [CNCF Sandbox project](https://www.cncf.io/sandbox-projects/) that was originally built and sponsored by [Ænix](https://aenix.io/).
1817

1918
With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters,
2019
Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.
@@ -34,7 +33,6 @@ You can use Cozystack as a platform to build a private cloud powered by Infrastr
3433
* [**Using Cozystack as a Kubernetes distribution**](https://cozystack.io/docs/guides/use-cases/kubernetes-distribution/)
3534
You can use Cozystack as a Kubernetes distribution for Bare Metal
3635

37-
3836
## Documentation
3937

4038
The documentation is located on the [cozystack.io](https://cozystack.io) website.
@@ -45,10 +43,10 @@ If you encounter any difficulties, start with the [troubleshooting guide](https:
4543

4644
## Versioning
4745

48-
Versioning adheres to the [Semantic Versioning](http://semver.org/) principles.
46+
Versioning adheres to the [Semantic Versioning](https://semver.org/) principles.
4947
A full list of the available releases is available in the GitHub repository's [Release](https://github.com/cozystack/cozystack/releases) section.
5048

51-
- [Roadmap](https://cozystack.io/docs/roadmap/)
49+
- [Roadmap](ROADMAP.md)
5250

5351
## Contributions
5452

@@ -57,16 +55,28 @@ Contributions are highly appreciated and very welcomed!
5755
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.
5856
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.
5957

60-
You can express your intention to on the fix on your own.
58+
You are welcome to take the fix on yourself.
6159
Commits are used to generate the changelog, and their author will be referenced in it.
6260

6361
If you have a **concrete feature request**, [open an issue](https://github.com/cozystack/cozystack/issues/new/choose). For a **cross-cutting or architectural change**, open a [design proposal](https://github.com/cozystack/community/tree/main/design-proposals) in the [community](https://github.com/cozystack/community) repo. For **questions or early ideas**, use [GitHub Discussions](https://github.com/cozystack/cozystack/discussions). See [CONTRIBUTING.md](CONTRIBUTING.md#where-do-i-file) for the full routing.
6462

6563
## Community
6664

67-
You are welcome to join our [Telegram group](https://t.me/cozystack) and come to our weekly community meetings.
65+
You are welcome to join us in [#cozystack on CNCF Slack](https://cloud-native.slack.com/archives/C08BQJD95J7) or [#cozystack on Kubernetes Slack](https://kubernetes.slack.com/archives/C06L3CPRVN1), join our [Telegram group](https://t.me/cozystack), and come to our community meetings.
6866
Add them 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) for convenience.
6967

68+
## Project documents
69+
70+
| | |
71+
|---|---|
72+
| [Governance](GOVERNANCE.md) | How decisions are made and who makes them |
73+
| [Contributor Ladder](CONTRIBUTOR_LADDER.md) | How to grow from contributor to maintainer |
74+
| [Maintainers](MAINTAINERS.md) | Who maintains the project |
75+
| [Code of Conduct](CODE_OF_CONDUCT.md) | What we expect of each other |
76+
| [Security Policy](SECURITY.md) | Reporting a vulnerability, and which releases get fixes |
77+
| [Adopters](ADOPTERS.md) | Who runs Cozystack in production |
78+
| [Roadmap](ROADMAP.md) | Where the project is going |
79+
7080
## License
7181

7282
Cozystack is licensed under Apache 2.0.

0 commit comments

Comments
 (0)