pleia2
commented
1 year ago I've started a Google Document (public comments enabled) where a small team is drafting up a description of each of the data sources: https://docs.google.com/document/d/1BEqezHZjRvwhBGWOip5_Mavg_pjYmEZhsmfn5ygx9Oc/edit?usp=sharing
In a discussion with @arshPratap , @Princee215 , and @aashish-khatri today we were discussing whether results from the Validated Software List should be included when queries are made against the respective distributions that validation instructions are provided for. Due to the possible confusion around what ships with a distribution versus what has been validated to work by IBM, it was decided not to merge these results, and instead users are required to use the appropriate checkboxes to search data sources.
As a result, we need to clarify exactly where the data for each of our back-end sources comes from by way of documentation.
For every entry in src/config/supported_distros.py there needs to be corresponding documentation explaining to the user precisely where the data is coming from.
For instance, in the case of Debian we can share that it comes from the package lists in https://www.debian.org/distrib/packages and for the Validated Software List it comes from the table at https://www.ibm.com/community/z/open-source-software/
A link to this documentation should be incorporated somewhere near the search bar of the tool, so it's easy for users to discover.