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

chore: Reduce length of readme, moving lengthy content to the wiki #2882

Merged
merged 2 commits into from
May 20, 2024

Conversation

popey
Copy link
Contributor

@popey popey commented May 17, 2024

👋

This PR reduces the length and complexity of the README.md.

I have removed a lot of additional information and put it in the wiki, linking to those pages from within the README. So, no information has been lost; it's just moved out of the project's front page.

The goal was to make the information here in the README more accessible and less overwhelming. 🙏

@kzantow
Copy link
Contributor

kzantow commented May 17, 2024

I wonder if the output format section should remain in the main readme or have some other reference in the basic usage section. The reason being things like "works seamlessly with Grype" are not true without this (the default table output will do nothing in Grype), and it's probably fairly fundamental to what people would use Syft for: if they want an SBOM, a table listing really isn't an SBOM and it definitely isn't an SBOM format that most people would want to use, so this seems like it should be very obvious up-front how to use this basic functionality. What do you think?

@spiffcs
Copy link
Contributor

spiffcs commented May 20, 2024

👋 Hey @popey! This is 🟢 on my end. I think the final bit for contributing is the DCO:

To add your Signed-off-by line to every commit in this branch:

Ensure you have a local copy of your branch by checking out the pull request locally via command line.
In your local branch, run: git rebase HEAD~2 --signoff
Force push your changes to overwrite the branch: git push --force-with-lease origin rationalise-readme

popey added 2 commits May 20, 2024 17:51
Agreed with @kzantow - the output formats is essential and doesn't bulk the readme out too much to have it in here.

Signed-off-by: Alan Pope <[email protected]>
@spiffcs spiffcs enabled auto-merge (squash) May 20, 2024 17:45
@spiffcs spiffcs merged commit 49c458b into anchore:main May 20, 2024
11 checks passed
@betaboon
Copy link

heya, even tho this has already been merged, I'd like to chime in.

Moving these information to the wiki has the downside that they are separately versioned.
this will make it hard if not impossible to to correlate the correct version of the information to the state of the repository.

Imagine i need to see the information on "Configuration" for a release of the past.

imho a better option would have been to move those sections from the readme into a docs/configuration.md etc, thus keeping them versioned together with the code.

@kzantow
Copy link
Contributor

kzantow commented May 23, 2024

Hey @betaboon -- just an FYI we are planning on introducing a config command so you can see exactly what your current version of syft supports: #2892

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