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

Create RSC dashboard markdown documents #223

Merged
merged 7 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ module.exports = {
title: '',
items: [{ text: 'API Reference', link: '/api-reference/' }],
},
{
items: [{ text: 'ReadySetCyber', link: '/rsc/user-guide' }],
},
],
secondaryLinks: [
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/documentation-pages/rsc/img/terms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
87 changes: 87 additions & 0 deletions docs/src/documentation-pages/rsc/user-guide.md
Original file line number Diff line number Diff line change
@@ -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)
Loading