-
Notifications
You must be signed in to change notification settings - Fork 58
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
readme: add project links #717
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, this looks good and is indeed more consistent with the rest of the projects
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we sure about this? Imagine a person coming first time to bootc-image-builder on github. The first section in the README is dedicated to links that are not helpful for the first time user.
As a first time user, I would expect information on how to install, and how to use it, which is what we currently have (the prerequisites section is quite weird, we should get rid of it). Basically: focus on the happy path. By putting the project information on the top, we are basically focusing on the sad path on which users stumbled and need help.
README.md
Outdated
- **Matrix**: #image-builder on [fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org) | ||
* **Discussions**: https://github.com/orgs/osbuild/discussions | ||
- **Mailing List**: <[email protected]> | ||
- **Changelog**: <https://github.com/osbuild/bootc-image-builder/releases> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is empty for bib, I suggest removing it.
README.md
Outdated
- **Bug Tracker**: <https://github.com/osbuild/bootc-image-builder/issues> | ||
- **Matrix**: #image-builder on [fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org) | ||
* **Discussions**: https://github.com/orgs/osbuild/discussions | ||
- **Mailing List**: <[email protected]> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be a hot take, but I think we should remove the mailing list from all repositories. No one knows how to subscribe, nor how to access archives. I'm fine living without a mailing list myself.
No hard feelings about any of that, moved to the bottom, removed maling list and changelog. Amended the change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Replaces #674