Merge pull request #223 from cisagov/207-add-markdown-documentation-f…

…or-rsc Create RSC dashboard markdown documents
cisagov · May 10, 2024 · a662e2e · a662e2e
2 parents 91bd4d9 + ba0bf27
commit a662e2e
Show file tree

Hide file tree

Showing 17 changed files with 90 additions and 0 deletions.
diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js
@@ -31,6 +31,9 @@ module.exports = {
         title: '',
         items: [{ text: 'API Reference', link: '/api-reference/' }],
       },
+      {
+        items: [{ text: 'ReadySetCyber', link: '/rsc/user-guide' }],
+      },
     ],
     secondaryLinks: [
       {

diff --git a/docs/src/documentation-pages/rsc/img/assessment.png b/docs/src/documentation-pages/rsc/img/assessment.png
diff --git a/docs/src/documentation-pages/rsc/img/click-details.png b/docs/src/documentation-pages/rsc/img/click-details.png
diff --git a/docs/src/documentation-pages/rsc/img/confirmation-code.png b/docs/src/documentation-pages/rsc/img/confirmation-code.png
diff --git a/docs/src/documentation-pages/rsc/img/no-assessment.png b/docs/src/documentation-pages/rsc/img/no-assessment.png
diff --git a/docs/src/documentation-pages/rsc/img/register-email.png b/docs/src/documentation-pages/rsc/img/register-email.png
diff --git a/docs/src/documentation-pages/rsc/img/register-now.png b/docs/src/documentation-pages/rsc/img/register-now.png
diff --git a/docs/src/documentation-pages/rsc/img/register-request.png b/docs/src/documentation-pages/rsc/img/register-request.png
diff --git a/docs/src/documentation-pages/rsc/img/register.png b/docs/src/documentation-pages/rsc/img/register.png
diff --git a/docs/src/documentation-pages/rsc/img/resources.png b/docs/src/documentation-pages/rsc/img/resources.png
diff --git a/docs/src/documentation-pages/rsc/img/rsc-create-account.png b/docs/src/documentation-pages/rsc/img/rsc-create-account.png
diff --git a/docs/src/documentation-pages/rsc/img/rsc-dashboard.png b/docs/src/documentation-pages/rsc/img/rsc-dashboard.png
diff --git a/docs/src/documentation-pages/rsc/img/rsc-login.png b/docs/src/documentation-pages/rsc/img/rsc-login.png
diff --git a/docs/src/documentation-pages/rsc/img/side-nav.png b/docs/src/documentation-pages/rsc/img/side-nav.png
diff --git a/docs/src/documentation-pages/rsc/img/sign-in.png b/docs/src/documentation-pages/rsc/img/sign-in.png
diff --git a/docs/src/documentation-pages/rsc/img/terms.png b/docs/src/documentation-pages/rsc/img/terms.png
diff --git a/docs/src/documentation-pages/rsc/user-guide.md b/docs/src/documentation-pages/rsc/user-guide.md
@@ -0,0 +1,87 @@
+---
+title: ReadySetCyber Dashboard
+---
+
+### Login
+
+ReadySetCyber dashboard users can only access the platform after completing a ReadySetCyber
+questionnaire and registering with their associated e-mail. You will then be prompted to
+create a user account.
+
+![login](./img/rsc-login.png)
+
+#### New Users
+
+New users will navigate to the ReadySetCyber Dashboard login and click ”Register Now”.
+
+![register now](./img/register-now.png)
+
+Enter the e-mail, First and Last name associated with the completed ReadySetCyber assessment.
+
+![register](./img/register.png)
+
+Once registration is complete, a new user will receive an e-mail with further registration steps.
+
+![register request](./img/register-request.png)
+
+Access the e-mail address previously entered and visit the enclosed link to complete registration.
+
+![register email](./img/register-email.png)
+
+**Create Account:**
+
+Complete the ”Create Account” fields with the email used for registration.
+
+![create account](./img/rsc-create-account.png)
+
+Once the fields have been completed, a confirmation code will be sent via e-mail to verify
+ownership of the e-mail address.
+
+![confirmation](./img/confirmation-code.png)
+
+Enter the confirmation code received via e-mail and continue to setup Two-Factor Authentication.
+Scan the QR Code on your mobile device to complete your account creation. Once Two-Factor Authentication has been completed, you will be directed to review and accept
+the “Terms of Service”. Once the “Terms of Service” have been accepted and submitted, registration
+is complete and you will be redirected to your ReadySetCyber Dashboard.
+
+![terms of service](./img/terms.png)
+
+#### Existing Users
+
+Once a user has completed the registration process and an assessment has been processed and
+received by ReadySetCyber Dashboard, return to the dashboard login. Once successfully logged in,
+a user will be directed to the dashboard view.
+
+![sign-in](./img/sign-in.png)
+
+### Overview
+
+Once you are logged in, you can view an overview of your past ReadySetCyber assessments.
+
+![dashboard](./img/rsc-dashboard.png)
+
+### Viewing assessment details
+
+If an assessment has been processed and received by ReadySetCyber Dashboard, it will
+be displayed as shown. To access a detailed view of your assessment, click on the
+desired assessment.
+
+![view details](./img/click-details.png)
+
+Details within an assessment result are displayed in the same format as the completed
+questionnaire. Displayed answers correspond to answers submitted from a completed
+ReadySetCyber questionnaire. You can save a copy of your completed assessment by clicking
+on **Download PDF**
+
+![assessment](./img/assessment.png)
+
+Responses marked “No”, “Not in Scope” or “Not Started” will display an associated
+resource. Resource types will be displayed with a brief description and a clickable
+link will be provided for all associated resources
+
+![resources](./img/resources.png)
+
+To quickly navigate through your assessment, a clickable side navigation and bottom navigation
+are provided. Click the desired category to be taken there.
+
+![side nav](./img/side-nav.png)