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

Eliminate need for side scrolling of CWE table in exploitation.md #530

Open
ahouseholder opened this issue Mar 5, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@ahouseholder
Copy link
Contributor

Is your feature request related to a problem? Please describe.

The formatting of the CWE /data/csvs/cwe/possible-cwe-with-poc-examples.csv file added in #376, when rendered in the static site, looks odd because the csv plugin forces side-scrolling.

Screenshot 2024-03-05 at 1 55 08 PM Screenshot 2024-03-05 at 1 55 15 PM

Describe the solution you'd like

I'd prefer that we eliminate the /data/csvs/cwe/possible-cwe-with-poc-examples.csv file and turn it into either a native markdown table or list of content blobs that live directly in docs/reference/decision_points/exploitation.md, replacing

{{ read_csv('cwe/possible-cwe-with-poc-examples.csv') }}

This would allow us to properly link to CWE definitions and tools as well.

Also, we should consider whether all the existing columns in /data/csvs/cwe/possible-cwe-with-poc-examples.csv are necessary. We accepted what was in #376 but didn't really consider whether it's representative of what we want to maintain over time.

Describe alternatives you've considered

  • Status quo: users have to side-scroll to see the whole table
  • Removing columns from the .csv could eliminate the side-scrolling problem if we got it narrow enough, but we still would be unable to easily link to CWE entries or other reference links.

Additional context

This issue was prompted by, but is otherwise independent of, #529 which recognizes the no-longer-correct subjunctive tense of words about CWE in /docs/topics/information_sources.md

@ahouseholder ahouseholder added the enhancement New feature or request label Mar 5, 2024
@ahouseholder ahouseholder changed the title Add a concise title for your request Eliminate need for side scrolling of CWE table in exploitation.md Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant