Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create style guide for FedRAMP OSCAL Constraints (GSA#760)
* 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 <[email protected]> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <[email protected]> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <[email protected]> * Update fedramp-external-constraints.xml Co-authored-by: Gabeblis <[email protected]> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <[email protected]> * Update src/validations/constraints/fedramp-external-constraints.xml Co-authored-by: Gabeblis <[email protected]> * Update dev-constraint.js --------- Co-authored-by: Gabeblis <[email protected]> * [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 <[email protected]> * [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 <[email protected]> * [skip ci] Update FRR1 in table listing too Co-authored-by: David Waltermire <[email protected]> * [skip ci] Add space in status row of table for FRR2 Co-authored-by: David Waltermire <[email protected]> * [skip ci] Add missing word to FRR3 title Co-authored-by: David Waltermire <[email protected]> * [skip ci] Improve the prose in FRR2 guidance Co-authored-by: David Waltermire <[email protected]> * [skip ci] Reorder statements in sentence of FRR2 guidance Co-authored-by: David Waltermire <[email protected]> * [skip ci] Clarify ambiguous wording in FRR5 Co-authored-by: David Waltermire <[email protected]> * [skip ci] Correct typos in FRR6 formal name Co-authored-by: David Waltermire <[email protected]> * [skip ci] Make FRR7 formal name more explicit Co-authored-by: David Waltermire <[email protected]> * [skip ci] Improve FRR8 formal name Co-authored-by: David Waltermire <[email protected]> * [skip ci] Fix FRR8 formal name in table index Co-authored-by: David Waltermire <[email protected]> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <[email protected]> * [skip ci] Fix FRR9 formal name in table index Co-authored-by: David Waltermire <[email protected]> * [skip ci] Adjust FRR9 guidance to specify expect constraints Co-authored-by: David Waltermire <[email protected]> * [skip ci] Adjust FRR9 constraint examples for correct type Co-authored-by: David Waltermire <[email protected]> * [skip ci] Adjust FRR10 formal name to be more clear Co-authored-by: David Waltermire <[email protected]> * [skip ci] Fix FRR10 formal name in table index Co-authored-by: David Waltermire <[email protected]> * [skip ci] Make FRR11 formal name better sentence fragment Co-authored-by: David Waltermire <[email protected]> * [skip ci] Fix FRR11 above requirement text Co-authored-by: David Waltermire <[email protected]> * [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 <[email protected]> * [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 <[email protected]> Co-authored-by: wandmagic <[email protected]> Co-authored-by: Gabeblis <[email protected]> Co-authored-by: David Waltermire <[email protected]>
- Loading branch information
5 people
committed
Nov 1, 2024
1 parent
62721a1
commit 2e4a27e