Configuration page in Wiki not up to date

[Joerki]

Hi,

you have a configuration description on Wiki page

https://github.com/anchore/syft/wiki/configuration

If I look at Syfts debug output and see how it is configured it see that the Wiki page is outdated.

The page should be up to date and contain an explanation for all settings I see in Syft's log.
I work both with a YAML config file and command line parameters.

BR

[kzantow]

You are right. It would be good to update that page automatically each release, or have some other versioned documentation with the right configuration for the specific version of Syft. As noted on the page, syft config will display the full set of configuration for your version of syft, maybe we just need to make this more apparent?

[Joerki]

When I take a close look I see that syft config and Wiki page do not give the same details.

I suggest a general improvement based on a single souce (exposed with syft config and Wiki page), so that a reader can rely on one of these sources plus command line help.

Config_entry:

• Purpose (short, also for command line help)
• Purpose (detailed to understand the setting, optional if short purpose is enough)
• YAML example (optional)
• command line option (optional, with description of alternative values if different to YAML setting)
• env parameter (optional, like command line option)

Information items should not be documented in the same line to improve readability.

The output of syft config into a file should be valid as a basis for customization (I did not check if this is already the case).

[spiffcs]

Configuration can now be seen here: https://oss.anchore.com/docs/reference/syft/configuration/ 😄
This should be the latest and greatest config. If there are more issues here we can open new issues for the oss docs site