VulnerabilityHistoryProject / vulnerability-history

vulnerabilityhistory.org
MIT License
33 stars 5 forks source link

Add "Examples" to the question template and UI #1075

Closed andymeneely closed 1 year ago

andymeneely commented 1 year ago

I'd like to have a way to structure the instructions to not be overwhelming. So let's add a tab to the UI that allows for examples.

So a question might have instructions, and then you can click on Examples to see some project-specific examples.

This involves:

brianravi commented 1 year ago

@andymeneely should "Examples" be an array of "example"s of a specific data type? or a text block in which to list examples?

andymeneely commented 1 year ago

Let's go with text block - that way I can have more flexibility

brianravi commented 1 year ago

sounds good, thanks! @jasonvelardeavi please make it so :)

jasonvelardeavi commented 1 year ago

The examples field can either be a string or an array of strings. The string accepts html while the array of strings will produce an unordered list.

e.g. "examples": "For true answers: <ul><li>SQL injection</li><li>bugger overflow</li></ul>" or "examples": ["one","two","three"]

brianravi commented 1 year ago

looks good, thanks! this is now in the curation-wizard branch