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

Add help page #30

Closed
djpackham opened this issue Jan 25, 2018 · 0 comments
Closed

Add help page #30

djpackham opened this issue Jan 25, 2018 · 0 comments

Comments

@djpackham
Copy link
Contributor

djpackham commented Jan 25, 2018

Provide a help page that includes helpful information for using the tool. The help page should be linked from the main landing page. Using something like a question mark icon to get to the help page would work.

Help page should include the following sections:

  • Background section
    • Summary of the tool (what it is, why we developed it, who can use it)
  • How to use the tool section
    • Describe the meaning and purpose of each of the fields (Policy, Version, Profile)
    • Describe different ways to upload a certificate (text, file upload, drag-and-drop).
  • Report section
    • Step through the different sections of the report and provide details
  • Help and feature request section
    • Provide our icam at gsa.gov email address for any help or feature requests.
    • Guide folks to use the GitHub issues page for requests.
    • Provide some steps folks will need to take if they experience issues. For instance, email your certificate to icam at gsa.gov (will need to rename cert to .txt file extensions) or submit an issue and attach the file to the issue (user will need to create a github account in order to do this). I say the submit an issue and attach the file is the preferred approach.
    • Provide steps if there is a discrepancy with the results (what happens if there is a false-positive or false-negative). Probably follow similar approach as bullet above.
@mttcpr mttcpr closed this as completed Jan 29, 2020
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

No branches or pull requests

2 participants