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

Issue #3143 – fixed format conversion docs link #3407

Merged
merged 2 commits into from
Nov 1, 2024

Conversation

Makefolder
Copy link
Contributor

Description

Brought back the Format conversion documentation. The documentation of this feature was removed in commit 49c458b (May 20th, 2024) and was supposed to appear in the repository's wiki.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation (updates the documentation)
  • Chore (improve the developer experience, fix a test flake, etc, without changing the visible behavior of Syft)

Checklist:

  • I have added unit tests that cover changed behavior
  • I have tested my code in common scenarios and confirmed there are no regressions
  • I have added comments to my code, particularly in hard-to-understand sections

Signed-off-by: Artemii Fedotov <artemii.fedotov@tutamail.com>
README.md Outdated
@@ -120,6 +120,31 @@ Where the `formats` available are:

Note that flags using the @<version> can be used for earlier versions of each specification as well.

## Format conversion (experimental)
Copy link
Contributor

Choose a reason for hiding this comment

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

Most of the content was moved from the main README to the wiki in order to help focus new users on the specific needs to get started. Instead of adding this, we should probably update to point to this page on the wiki: https://github.com/anchore/syft/wiki/format-conversion

Copy link
Contributor Author

@Makefolder Makefolder Nov 1, 2024

Choose a reason for hiding this comment

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

Alright, on my way to fix it! Should I delete this pull request? I couldn't find this on the wiki page and I don't think I have permissions to edit that.

Copy link
Contributor

Choose a reason for hiding this comment

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

It was hidden on the wrong page. I moved that content to its own top-level wiki page just now, as it should have been.

Signed-off-by: Artemii Fedotov <artemii.fedotov@tutamail.com>
Copy link
Contributor

@kzantow kzantow left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution, @Makefolder

@spiffcs spiffcs merged commit 6a1e3f3 into anchore:main Nov 1, 2024
12 checks passed
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.

syft convert: broken link in help - documentation no longer existing
3 participants