vulnerablecode icon indicating copy to clipboard operation
vulnerablecode copied to clipboard

Add minimal About page/documentation

Open pombredanne opened this issue 3 years ago • 4 comments

This would be needed for going live.

  • [x] This should be an About in the top bar just left of the version and that would display simple text like the about in https://github.com/nexb/vulnerablecode
  • [ ] The about text should also provide an email to ask for an API key to access the API for https://github.com/nexB/vulnerablecode/issues/460#issuecomment-1219653083
  • [ ] #923

pombredanne avatar Aug 18 '22 15:08 pombredanne

About info added 1 or 2 days ago in push to https://github.com/nexB/vulnerablecode/pull/847.

Re (1) about text should also provide an email to ask for an API key to access the API and (2) We also need minimal contact info or it could be in the footer, I'll implement as soon as someone provides the desired text, email address, contact info etc.

johnmhoran avatar Aug 24 '22 18:08 johnmhoran

@pombredanne Re the About text and the need for API key instructions and minimal contact info, this is what the new About currently looks like when the user hovers over About in the navbar (as discussed, this comes from the upper-right corner of the GH README):

image

johnmhoran avatar Aug 24 '22 19:08 johnmhoran

This About is fine. Thanks!

pombredanne avatar Aug 30 '22 15:08 pombredanne

We need to define the TOS and criteria for providing API access before not after. We would need a way to confirm identity and contact the user when there are issues.

mjherzog avatar Sep 08 '22 23:09 mjherzog

See https://github.com/nexB/vulnerablecode/issues/923 for details and follow up.

pombredanne avatar Sep 27 '22 15:09 pombredanne

I suggest this footer:

VulnerableCode is free software by nexB Inc. and others | Source code license: Apache-2.0 | Data license: CC-BY-SA-4.0 | Terms of Service

Terms of service should link to a file saved in this repo and we should ensure that the ToS tells clearly that they apply to nexB-hosted VulnerableCode instances.

pombredanne avatar Sep 27 '22 16:09 pombredanne

Addressed in #933

johnmhoran avatar Sep 30 '22 20:09 johnmhoran