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

docs: add general coverage page #3859

Merged
merged 2 commits into from
Jun 11, 2023
Merged

docs: add general coverage page #3859

merged 2 commits into from
Jun 11, 2023

Conversation

itaysk
Copy link
Contributor

@itaysk itaysk commented Mar 16, 2023

Description

added a high-level doc that shows a growing list of supported languages and platforms. This is not supposed to be the complete supportability matrix, but a landing page that can give a quick hint if we support X or not, and if so, where to find the full details.

Let me know if you think it's helpful

@AnaisUrlichs
Copy link
Member

I think this is good since many people don't read beyond the getting started -- do you think a list is better readable than a table?
Somewhat independent of this PR, I am worried that we keep adding things to make the docs more readable and through that duplicating sections e.g. we have to make sure the list will stay up to date in addition to the table https://aquasecurity.github.io/trivy/v0.38/docs/vulnerability/detection/language/

@itaysk
Copy link
Contributor Author

itaysk commented Mar 20, 2023

do you think a list is better readable than a table?

if we want to add more columns then we'd need a table, but the motivation of this page was to simplify the existing tables.

we have to make sure the list will stay up to date in addition to the table

yes there's no new information in this page. it is a summarization of existing information to have a single link we can send everyone asking "does trivy support X language" to. If they want a quick go/no-go they'll find the answer here. If they want to dive deeper they can read the detailed tables which are linked to from here

@knqyf263
Copy link
Collaborator

Conflicting now

@itaysk
Copy link
Contributor Author

itaysk commented May 30, 2023

fixed

@knqyf263 knqyf263 merged commit 139f3e1 into aquasecurity:main Jun 11, 2023
3 checks passed
AnaisUrlichs pushed a commit to AnaisUrlichs/trivy that referenced this pull request Aug 10, 2023
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.

None yet

4 participants