Hotfix/info #780
Merged
Hotfix/info #780
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
Gabeblis
reviewed
Oct 17, 2024
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
|
Thanks for the review! |
kyhu65867
requested changes
Oct 17, 2024
Gabeblis
reviewed
Oct 17, 2024
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
aj-stein-gsa
approved these changes
Oct 18, 2024
1 task
Gabeblis
approved these changes
Oct 21, 2024
wandmagic
added a commit
that referenced
this pull request
Oct 21, 2024
* fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
aj-stein-gsa
pushed a commit
that referenced
this pull request
Oct 23, 2024
* fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
aj-stein-gsa
added a commit
that referenced
this pull request
Oct 23, 2024
* Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
7 tasks
aj-stein-gsa
added a commit
that referenced
this pull request
Oct 31, 2024
* Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
wandmagic
added a commit
that referenced
this pull request
Nov 1, 2024
* Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
wandmagic
added a commit
that referenced
this pull request
Nov 1, 2024
* Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
wandmagic
added a commit
that referenced
this pull request
Nov 1, 2024
* Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
Gabeblis
added a commit
to Gabeblis/fedramp-automation
that referenced
this pull request
Nov 1, 2024
* Remove FedRAMP namespace from 'data-center' props (GSA#795) * Hotfix/info (GSA#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for GSA#675 * [skip ci] FSCR-1 re external constraints for GSA#675 * [skip ci] FCSR-1, woops, need formal name for GSA#675 * [skip ci] Tweak FCSR-1 anchor ID in GSA#675 * [skip ci] Stop header hacks for IDs in GSA#675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for GSA#675 * [skip ci] Add FCSR-3 about alpha sorting for GSA#675 * [skip ci] Add FCSR-4 to require help-url for GSA#675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for GSA#675 * [skip ci] @Rene2mt's feedback: level req for GSA#675 * [skip ci] @Rene2mt's review: why CRITICAL for GSA#675 * [skip ci] Woops, missed IDs for reqs for GSA#675 * [skip ci] Feedback: add message req for GSA#675 * [skip ci] Fix constraint path in examples for GSA#675 * [skip ci] Add remarks rec guidance for GSA#675 * [skip ci] Add @wandmagic's rec for FCSR-1 for GSA#675 * [skip ci] Add FCSR-10 re active voice for GSA#675 * [skip ci] Remove FCSR-10's incorrect only for GSA#675 * [skip ci] Add FCSR-11 about BCP14 words for GSA#675 * [skip ci] Add no-jargon req FCSR-12 for GSA#675 * [skip ci] Item, not sequence style req for GSA#675 * [skip ci] Add req for sequence ctx hints for GSA#675 * [skip ci] Add FCSR-15 re formal-names for GSA#675 * [skip ci] Remove anchor hack from FCSR-1 for GSA#675 * [skip ci] Wrap up kebab case IDs, reorder for GSA#675 * [skip ci] Fixes from @Rene2mt'2 review for GSA#675 * [skip ci] Add labels for rules in GSA#675 * [skip ci] Simplify rule titles for GSA#675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for GSA#645 * [skip ci] Limit informational constraints for GSA#675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for GSA#675 * [skip ci] Align formal names, spacing for GSA#675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish GSA#675 * [skip ci] Fold longer bg info for reqs in GSA#675 * [skip ci] Clarify FRR1 bad example is bad in GSA#645 * [skip ci] Clarify context order examples for GSA#675 * [skip ci] Clarify case sorting for FRR3 in GSA#675 * [skip ci] Clean up explanation of FRR10 for GSA#675 * [skip ci] Fix typos in FRR13 and FRR15 for GSA#675 * [skip ci] FRR2 feedback from Kylie for GSA#675 * [skip ci] Reword FRR9 with Kylie's feedback in GSA#675 * [skip ci] Woops, FRR16 twice, no FRR17 for GSA#675 * [skip ci] Last call and let reqs in FRR18 for GSA#675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in GSA#675 summary text * [skip ci] Tighten up summary text more for GSA#675 * [skip ci] Add back to top anchors for GSA#675 * [skip ci] Better grammar and flow for GSA#675 summary * [skip ci] Improve FRR102 guidance text for GSA#675 * [skip ci] Capitalize and fix FRR110 title for GSA#675 * [skip ci] Fix poor grammar in FRR117 text for GSA#675 * [skip ci] Explicit docs URL in FRR104 for GSA#675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for GSA#675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for GSA#675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. GSA#760 (comment) * [skip ci] Fix FRR108 conformant example for GSA#675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
Gabeblis
added a commit
to Gabeblis/fedramp-automation
that referenced
this pull request
Nov 1, 2024
* Remove FedRAMP namespace from 'data-center' props (GSA#795) * Hotfix/info (GSA#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for GSA#675 * [skip ci] FSCR-1 re external constraints for GSA#675 * [skip ci] FCSR-1, woops, need formal name for GSA#675 * [skip ci] Tweak FCSR-1 anchor ID in GSA#675 * [skip ci] Stop header hacks for IDs in GSA#675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for GSA#675 * [skip ci] Add FCSR-3 about alpha sorting for GSA#675 * [skip ci] Add FCSR-4 to require help-url for GSA#675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for GSA#675 * [skip ci] @Rene2mt's feedback: level req for GSA#675 * [skip ci] @Rene2mt's review: why CRITICAL for GSA#675 * [skip ci] Woops, missed IDs for reqs for GSA#675 * [skip ci] Feedback: add message req for GSA#675 * [skip ci] Fix constraint path in examples for GSA#675 * [skip ci] Add remarks rec guidance for GSA#675 * [skip ci] Add @wandmagic's rec for FCSR-1 for GSA#675 * [skip ci] Add FCSR-10 re active voice for GSA#675 * [skip ci] Remove FCSR-10's incorrect only for GSA#675 * [skip ci] Add FCSR-11 about BCP14 words for GSA#675 * [skip ci] Add no-jargon req FCSR-12 for GSA#675 * [skip ci] Item, not sequence style req for GSA#675 * [skip ci] Add req for sequence ctx hints for GSA#675 * [skip ci] Add FCSR-15 re formal-names for GSA#675 * [skip ci] Remove anchor hack from FCSR-1 for GSA#675 * [skip ci] Wrap up kebab case IDs, reorder for GSA#675 * [skip ci] Fixes from @Rene2mt'2 review for GSA#675 * [skip ci] Add labels for rules in GSA#675 * [skip ci] Simplify rule titles for GSA#675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for GSA#645 * [skip ci] Limit informational constraints for GSA#675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for GSA#675 * [skip ci] Align formal names, spacing for GSA#675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish GSA#675 * [skip ci] Fold longer bg info for reqs in GSA#675 * [skip ci] Clarify FRR1 bad example is bad in GSA#645 * [skip ci] Clarify context order examples for GSA#675 * [skip ci] Clarify case sorting for FRR3 in GSA#675 * [skip ci] Clean up explanation of FRR10 for GSA#675 * [skip ci] Fix typos in FRR13 and FRR15 for GSA#675 * [skip ci] FRR2 feedback from Kylie for GSA#675 * [skip ci] Reword FRR9 with Kylie's feedback in GSA#675 * [skip ci] Woops, FRR16 twice, no FRR17 for GSA#675 * [skip ci] Last call and let reqs in FRR18 for GSA#675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in GSA#675 summary text * [skip ci] Tighten up summary text more for GSA#675 * [skip ci] Add back to top anchors for GSA#675 * [skip ci] Better grammar and flow for GSA#675 summary * [skip ci] Improve FRR102 guidance text for GSA#675 * [skip ci] Capitalize and fix FRR110 title for GSA#675 * [skip ci] Fix poor grammar in FRR117 text for GSA#675 * [skip ci] Explicit docs URL in FRR104 for GSA#675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for GSA#675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for GSA#675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. GSA#760 (comment) * [skip ci] Fix FRR108 conformant example for GSA#675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
Gabeblis
added a commit
to Gabeblis/fedramp-automation
that referenced
this pull request
Nov 1, 2024
* Remove FedRAMP namespace from 'data-center' props (GSA#795) * Hotfix/info (GSA#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for GSA#675 * [skip ci] FSCR-1 re external constraints for GSA#675 * [skip ci] FCSR-1, woops, need formal name for GSA#675 * [skip ci] Tweak FCSR-1 anchor ID in GSA#675 * [skip ci] Stop header hacks for IDs in GSA#675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for GSA#675 * [skip ci] Add FCSR-3 about alpha sorting for GSA#675 * [skip ci] Add FCSR-4 to require help-url for GSA#675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for GSA#675 * [skip ci] @Rene2mt's feedback: level req for GSA#675 * [skip ci] @Rene2mt's review: why CRITICAL for GSA#675 * [skip ci] Woops, missed IDs for reqs for GSA#675 * [skip ci] Feedback: add message req for GSA#675 * [skip ci] Fix constraint path in examples for GSA#675 * [skip ci] Add remarks rec guidance for GSA#675 * [skip ci] Add @wandmagic's rec for FCSR-1 for GSA#675 * [skip ci] Add FCSR-10 re active voice for GSA#675 * [skip ci] Remove FCSR-10's incorrect only for GSA#675 * [skip ci] Add FCSR-11 about BCP14 words for GSA#675 * [skip ci] Add no-jargon req FCSR-12 for GSA#675 * [skip ci] Item, not sequence style req for GSA#675 * [skip ci] Add req for sequence ctx hints for GSA#675 * [skip ci] Add FCSR-15 re formal-names for GSA#675 * [skip ci] Remove anchor hack from FCSR-1 for GSA#675 * [skip ci] Wrap up kebab case IDs, reorder for GSA#675 * [skip ci] Fixes from @Rene2mt'2 review for GSA#675 * [skip ci] Add labels for rules in GSA#675 * [skip ci] Simplify rule titles for GSA#675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for GSA#645 * [skip ci] Limit informational constraints for GSA#675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for GSA#675 * [skip ci] Align formal names, spacing for GSA#675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish GSA#675 * [skip ci] Fold longer bg info for reqs in GSA#675 * [skip ci] Clarify FRR1 bad example is bad in GSA#645 * [skip ci] Clarify context order examples for GSA#675 * [skip ci] Clarify case sorting for FRR3 in GSA#675 * [skip ci] Clean up explanation of FRR10 for GSA#675 * [skip ci] Fix typos in FRR13 and FRR15 for GSA#675 * [skip ci] FRR2 feedback from Kylie for GSA#675 * [skip ci] Reword FRR9 with Kylie's feedback in GSA#675 * [skip ci] Woops, FRR16 twice, no FRR17 for GSA#675 * [skip ci] Last call and let reqs in FRR18 for GSA#675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in GSA#675 summary text * [skip ci] Tighten up summary text more for GSA#675 * [skip ci] Add back to top anchors for GSA#675 * [skip ci] Better grammar and flow for GSA#675 summary * [skip ci] Improve FRR102 guidance text for GSA#675 * [skip ci] Capitalize and fix FRR110 title for GSA#675 * [skip ci] Fix poor grammar in FRR117 text for GSA#675 * [skip ci] Explicit docs URL in FRR104 for GSA#675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for GSA#675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for GSA#675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. GSA#760 (comment) * [skip ci] Fix FRR108 conformant example for GSA#675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
aj-stein-gsa
added a commit
that referenced
this pull request
Nov 1, 2024
* Create style guide for FedRAMP OSCAL Constraints (#760) * Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * Apply Style Guide To Constraints (#852) * Add props to each constraint that has sufficient existing documentation * Sort constraints alphabetically and sort ascending by metapath specificity * Add missing (and available) help-url * IETF BCP14 Keywords in Constraint Messages * spacing between context blocks for readability * sort alphabetically and use consistent spcaing. * Add style guide constraints Add constraints to enforce style guide Place holders for constraints to add when necessary functions for implementation are supported Add formal names space Add back constraint Delete temporary test file Point help-url to develop Clean up id and formal name Script name change to test:style * Clean up errors by adding place holder urls and change data-center-US to lowercase. Small touch up to style guide step. * make id lowercase * remove space * inject schema Co-authored-by: A.J. Stein <aj@gsa.gov> * TODO * Move style guide * TODO * add help-url --------- Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> Co-authored-by: A.J. Stein <aj@gsa.gov>
wandmagic
added a commit
that referenced
this pull request
Nov 4, 2024
* Create style guide for FedRAMP OSCAL Constraints (#760) * Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * Apply Style Guide To Constraints (#852) * Add props to each constraint that has sufficient existing documentation * Sort constraints alphabetically and sort ascending by metapath specificity * Add missing (and available) help-url * IETF BCP14 Keywords in Constraint Messages * spacing between context blocks for readability * sort alphabetically and use consistent spcaing. * Add style guide constraints Add constraints to enforce style guide Place holders for constraints to add when necessary functions for implementation are supported Add formal names space Add back constraint Delete temporary test file Point help-url to develop Clean up id and formal name Script name change to test:style * Clean up errors by adding place holder urls and change data-center-US to lowercase. Small touch up to style guide step. * make id lowercase * remove space * inject schema Co-authored-by: A.J. Stein <aj@gsa.gov> * TODO * Move style guide * TODO * add help-url --------- Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> Co-authored-by: A.J. Stein <aj@gsa.gov>
wandmagic
added a commit
that referenced
this pull request
Nov 5, 2024
* Create style guide for FedRAMP OSCAL Constraints (#760) * Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * Apply Style Guide To Constraints (#852) * Add props to each constraint that has sufficient existing documentation * Sort constraints alphabetically and sort ascending by metapath specificity * Add missing (and available) help-url * IETF BCP14 Keywords in Constraint Messages * spacing between context blocks for readability * sort alphabetically and use consistent spcaing. * Add style guide constraints Add constraints to enforce style guide Place holders for constraints to add when necessary functions for implementation are supported Add formal names space Add back constraint Delete temporary test file Point help-url to develop Clean up id and formal name Script name change to test:style * Clean up errors by adding place holder urls and change data-center-US to lowercase. Small touch up to style guide step. * make id lowercase * remove space * inject schema Co-authored-by: A.J. Stein <aj@gsa.gov> * TODO * Move style guide * TODO * add help-url --------- Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> Co-authored-by: A.J. Stein <aj@gsa.gov>
wandmagic
added a commit
that referenced
this pull request
Nov 6, 2024
* Create style guide for FedRAMP OSCAL Constraints (#760) * Remove FedRAMP namespace from 'data-center' props (#795) * Hotfix/info (#780) * fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Create style guide doc for #675 * [skip ci] FSCR-1 re external constraints for #675 * [skip ci] FCSR-1, woops, need formal name for #675 * [skip ci] Tweak FCSR-1 anchor ID in #675 * [skip ci] Stop header hacks for IDs in #675 I read more about these techniques than I would like, but none of them appear to work effectively for making anchors like `#fcsr-1` without adding other content to the anchor which I would like to avoid. https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584 Either it never worked or something changed. Oh well! * [skip ci] Add FCSR-2 on context sorting for #675 * [skip ci] Add FCSR-3 about alpha sorting for #675 * [skip ci] Add FCSR-4 to require help-url for #675 * [skip ci] Adjust title from style guide to dev style guide per Rene's review * [skip ci] Adjust grammar and style per Rene's review Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> * [skip ci] @Rene2mt's feedback: add ID req for #675 * [skip ci] @Rene2mt's feedback: level req for #675 * [skip ci] @Rene2mt's review: why CRITICAL for #675 * [skip ci] Woops, missed IDs for reqs for #675 * [skip ci] Feedback: add message req for #675 * [skip ci] Fix constraint path in examples for #675 * [skip ci] Add remarks rec guidance for #675 * [skip ci] Add @wandmagic's rec for FCSR-1 for #675 * [skip ci] Add FCSR-10 re active voice for #675 * [skip ci] Remove FCSR-10's incorrect only for #675 * [skip ci] Add FCSR-11 about BCP14 words for #675 * [skip ci] Add no-jargon req FCSR-12 for #675 * [skip ci] Item, not sequence style req for #675 * [skip ci] Add req for sequence ctx hints for #675 * [skip ci] Add FCSR-15 re formal-names for #675 * [skip ci] Remove anchor hack from FCSR-1 for #675 * [skip ci] Wrap up kebab case IDs, reorder for #675 * [skip ci] Fixes from @Rene2mt'2 review for #675 * [skip ci] Add labels for rules in #675 * [skip ci] Simplify rule titles for #675 Follow feedback from @brian-ruf in his review. * [skip ci] Finalize table index with reqs for #645 * [skip ci] Limit informational constraints for #675 * [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR Given related work in the program, I want to generalize the prefix to be more general and global for all form of FedRAMP requirements down the road. * [skip ci] Add missing examples to FRR17 for #675 * [skip ci] Align formal names, spacing for #675 I had to fix up some of the formal names where Dave covered some of them in many places, but not all. Also other suggestions add some space. * [skip ci] Add level to many examples, finish #675 * [skip ci] Fold longer bg info for reqs in #675 * [skip ci] Clarify FRR1 bad example is bad in #645 * [skip ci] Clarify context order examples for #675 * [skip ci] Clarify case sorting for FRR3 in #675 * [skip ci] Clean up explanation of FRR10 for #675 * [skip ci] Fix typos in FRR13 and FRR15 for #675 * [skip ci] FRR2 feedback from Kylie for #675 * [skip ci] Reword FRR9 with Kylie's feedback in #675 * [skip ci] Woops, FRR16 twice, no FRR17 for #675 * [skip ci] Last call and let reqs in FRR18 for #675 * [skip ci] Correct ID for FRR18 to anchor in table Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * [skip ci] Offset req ID sequence Per discussion with others on a call with leads and staff from both FR branches, begin with an offset sequences and reserve the first 100 for other uses for the time being. /cc @kscarf1 * [skip ci] BCP14 keywords in #675 summary text * [skip ci] Tighten up summary text more for #675 * [skip ci] Add back to top anchors for #675 * [skip ci] Better grammar and flow for #675 summary * [skip ci] Improve FRR102 guidance text for #675 * [skip ci] Capitalize and fix FRR110 title for #675 * [skip ci] Fix poor grammar in FRR117 text for #675 * [skip ci] Explicit docs URL in FRR104 for #675 Address missing feedback to @kyhu65867 from review that had not been previously addressed by yours truly. * [skip ci] Fix FRR105 with feedback for #675 Address some feedback about wording and style of the unique ID req. * [skip ci] Fix FRR103 spacing for #675 Completely address feedback from @david-waltermire after checking for final review of style guide left in the comment below. #760 (comment) * [skip ci] Fix FRR108 conformant example for #675 --------- Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> * Apply Style Guide To Constraints (#852) * Add props to each constraint that has sufficient existing documentation * Sort constraints alphabetically and sort ascending by metapath specificity * Add missing (and available) help-url * IETF BCP14 Keywords in Constraint Messages * spacing between context blocks for readability * sort alphabetically and use consistent spcaing. * Add style guide constraints Add constraints to enforce style guide Place holders for constraints to add when necessary functions for implementation are supported Add formal names space Add back constraint Delete temporary test file Point help-url to develop Clean up id and formal name Script name change to test:style * Clean up errors by adding place holder urls and change data-center-US to lowercase. Small touch up to style guide step. * make id lowercase * remove space * inject schema Co-authored-by: A.J. Stein <aj@gsa.gov> * TODO * Move style guide * TODO * add help-url --------- Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com> Co-authored-by: David Waltermire <david.waltermire@gsa.gov> Co-authored-by: A.J. Stein <aj@gsa.gov>
brian-ruf
pushed a commit
to brian-ruf/fedramp-automation
that referenced
this pull request
Nov 8, 2024
* fix informational constraint handling and make ssp-all valid correct * revert external constraint changes * Update fedramp-external-constraints.xml * Update fedramp_extensions_steps.ts * update info handling * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
This was referenced Nov 13, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Committer Notes
Fix handling of informational constraints by test runner. Fixes #797.
All Submissions:
If applicable, have all FedRAMP Documents Related to OSCAL Adoption affected by the changes in this issue have been updated?If applicable, does this PR reference the issue it addresses and explain how it addresses the issue?By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.