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.

Sign up for GitHub

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

Jump to bottom

Add minimal About page/documentation including ToS #856

Closed
3 tasks done
pombredanne opened this issue Aug 18, 2022 · 7 comments
Closed
3 tasks done

Add minimal About page/documentation including ToS #856

pombredanne opened this issue Aug 18, 2022 · 7 comments
Assignees
@johnmhoran
Labels
documentation Everything about documentation
Milestone
v30.0

Comments

@pombredanne
Copy link
Collaborator

pombredanne commented Aug 18, 2022 •
edited
Loading

This would be needed for going live.
@pombredanne pombredanne added the documentation Everything about documentation label Aug 18, 2022
@pombredanne pombredanne added this to the v30.0 milestone Aug 18, 2022
@pombredanne pombredanne changed the title Add minimal Aout page/documentation Add minimal About page/documentation Aug 18, 2022
johnmhoran added a commit that referenced this issue Aug 23, 2022
@johnmhoran
Add url property to Alias model and implement
fbb895a 
Reference: #856
Reference: #860

- Added Alias URLs to vulnerability search results and details templates.
- Added external link icons to Alias URLs.
- Added about info to navbar.
- Still need contact info and something re obtaining API key.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@johnmhoran
Copy link
Contributor

About info added 1 or 2 days ago in push to #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
Copy link
Contributor

@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

@pombredanne
Copy link
Collaborator Author

This About is fine. Thanks!

TG1999 pushed a commit to TG1999/vulnerablecode that referenced this issue Sep 5, 2022
@johnmhoran @TG1999
Add url property to Alias model and implement
7a4c798 
Reference: aboutcode-org#856
Reference: aboutcode-org#860

- Added Alias URLs to vulnerability search results and details templates.
- Added external link icons to Alias URLs.
- Added about info to navbar.
- Still need contact info and something re obtaining API key.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@mjherzog
Copy link
Member

mjherzog commented Sep 8, 2022 •
edited
Loading

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.

@pombredanne
Copy link
Collaborator Author

See #923 for details and follow up.

@pombredanne pombredanne changed the title Add minimal About page/documentation Add minimal About page/documentation including ToS Sep 27, 2022
@pombredanne
Copy link
Collaborator Author

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.

johnmhoran added a commit that referenced this issue Sep 28, 2022
@johnmhoran
Add API contact info to about, add TOS #856
508584c 
Reference: #856

Reference: #923

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@johnmhoran johnmhoran mentioned this issue Sep 28, 2022
Closed
johnmhoran added a commit that referenced this issue Sep 30, 2022
@johnmhoran
Add TOS and API key contact info
9c05b97 
Reference: #856

Reference: #923

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@johnmhoran johnmhoran mentioned this issue Sep 30, 2022
Merged
@johnmhoran
Copy link
Contributor

Addressed in #933

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnmhoran johnmhoran

Labels
documentation Everything about documentation
Projects
None yet
Milestone
v30.0
Development

No branches or pull requests
3 participants
@pombredanne @mjherzog @johnmhoran