Skip to content
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

Merged
merged 1 commit into from
Dec 10, 2024
Merged

readme: add project links #717

merged 1 commit into from
Dec 10, 2024

Conversation

lzap
Copy link
Contributor

@lzap lzap commented Nov 15, 2024

Replaces #674

@lzap lzap mentioned this pull request Nov 15, 2024
mvo5
mvo5 previously approved these changes Nov 18, 2024
Copy link
Collaborator

@mvo5 mvo5 left a 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

achilleas-k
achilleas-k previously approved these changes Nov 28, 2024
Copy link
Member

@ondrejbudai ondrejbudai left a 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 Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ondrejbudai ondrejbudai disabled auto-merge November 29, 2024 10:33
@lzap
Copy link
Contributor Author

lzap commented Nov 29, 2024

No hard feelings about any of that, moved to the bottom, removed maling list and changelog. Amended the change.

@lzap lzap dismissed stale reviews from mvo5 and achilleas-k via 26575f0 November 29, 2024 10:48
Copy link
Member

@ondrejbudai ondrejbudai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mvo5 mvo5 added this pull request to the merge queue Dec 10, 2024
Merged via the queue into osbuild:main with commit 93524e3 Dec 10, 2024
7 of 9 checks passed
@lzap lzap deleted the links-1 branch December 10, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants