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

Display System Short Name and Description for SSP #611

Merged
merged 2 commits into from
Sep 12, 2022

Conversation

hreineck
Copy link
Contributor

@hreineck hreineck commented Sep 9, 2022

Add to the System Characteristics section of the SSP Viewer to display the system's short name next to the system name, and display the description underneath the system name.

The short name functionality can be tested using FedRAMP's SSP Template.

Add to the System Characteristics section of the SSP Viewer
to display the system's short name next to the system name,
and display the description underneath the system name.
@hreineck hreineck requested a review from a team September 9, 2022 18:32
@hreineck hreineck self-assigned this Sep 9, 2022
Copy link
Contributor

@kylelaker kylelaker left a comment

Choose a reason for hiding this comment

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

Minor style and linting requests

Comment on lines 31 to 34
{/* Render the system's short name in parentheses next to the name,
but only if the short name exists. */}
{props.systemCharacteristics["system-name-short"] &&
" (" + props.systemCharacteristics["system-name-short"] + ")"}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{/* Render the system's short name in parentheses next to the name,
but only if the short name exists. */}
{props.systemCharacteristics["system-name-short"] &&
" (" + props.systemCharacteristics["system-name-short"] + ")"}
{
// Render the system's short name in parentheses next to the
// name, but only if the short name exists.
props.systemCharacteristics["system-name-short"] &&
`(${props.systemCharacteristics["system-name-short"]})`
}

Copy link
Contributor

@kylelaker kylelaker Sep 9, 2022

Choose a reason for hiding this comment

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

This comment may still upset the linter -- but I want to use this (${}) with string interpolation instead of string concatenation. So this may need another npm run lint:fix once it's been applied.

</Grid>
<Grid item xs={6}>
<Typography variant="body2">
{props.systemCharacteristics["description"]}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{props.systemCharacteristics["description"]}
{props.systemCharacteristics.description}

@kylelaker kylelaker linked an issue Sep 9, 2022 that may be closed by this pull request
Address linter errors.
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.

Looks good to me! Here is a nice picture of it running in the Viewer.

image

@kylelaker kylelaker merged commit b9a4c96 into develop Sep 12, 2022
@kylelaker kylelaker deleted the feature/display-ssp-short-name-and-description branch September 12, 2022 12:38
@kylelaker kylelaker added the enhancement New feature or request label Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Display SSP System Short Name and Description
3 participants