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

Update README to reflect oscal-viewer & oscal-react-library changes #106

Merged
merged 8 commits into from
Jul 7, 2021

Conversation

Bronstrom
Copy link
Contributor

The README.md in example/ was outdated and didn't list some of the new features of the Viewer. More details were clarified about the Viewer and the sandbox environment is now listed with a link.

@tuckerzp tuckerzp requested review from rgauss and kylelaker July 7, 2021 19:53
@@ -33,9 +39,12 @@ npm start

## Testing

Within the `example/src` directory, run the following comands to run application tests and linter checks, respectively:
Within the `example/src` directory, run the following commands to run application tests and linter checks, respectively:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rephrase this sentence.

@Bronstrom Bronstrom changed the title Update README to reflect OSCAL viewer & OSCAL React Library changes Update README to reflect oscal-viewer & oscal-react-library changes Jul 7, 2021
@kylelaker
Copy link
Contributor

It might be good to consider adding a link to the /LICENSE file in example/README.md since there isn't one within the example/ directory (but there is still a new README & project).

@rgauss
Copy link
Contributor

rgauss commented Jul 7, 2021

@Bronstrom, can you load the FedRAMP moderate profile for the Profile Viewer screenshot?

@tuckerzp
Copy link
Contributor

tuckerzp commented Jul 7, 2021

@Bronstrom, can you load the FedRAMP moderate profile for the Profile Viewer screenshot?

Here is link:
https://raw.githubusercontent.com/GSA/fedramp-automation/master/baselines/rev4/json/FedRAMP_rev4_MODERATE-baseline_profile.json

@Bronstrom
Copy link
Contributor Author

Are we planning to make the FedRAMP moderate profile going to be the default in the future? If so, I'll update the description as well.

@rgauss
Copy link
Contributor

rgauss commented Jul 7, 2021

Are we planning to make the FedRAMP moderate profile going to be the default in the future? If so, I'll update the description as well.

Not yet.



TODO: Update details about OSCAL Viewer (EGRC-422)
An open sandbox environment of the project can be viewed at https://oscal-viewer.msd.easydynamics.com/catalog.


## Features
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Bronstrom, can we order the screenshots from 'bottom to top' in terms of the OSCAL 'stack':

  1. Catalog
  2. Profile
  3. Component Definition
  4. SSP

Copy link
Contributor Author

@Bronstrom Bronstrom Jul 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to reorder their names as well when they are mentioned?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, please.

Copy link
Contributor

@tuckerzp tuckerzp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linter is mad:

README.md Outdated Show resolved Hide resolved
@tuckerzp tuckerzp dismissed their stale review July 7, 2021 20:22

My concern was fixed

@kylelaker kylelaker merged commit 74cfc75 into develop Jul 7, 2021
@kylelaker kylelaker deleted the EGRC-422 branch July 7, 2021 20:38
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

Successfully merging this pull request may close these issues.

None yet

5 participants