Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FedRAMP needs a style guide for constraints #675

Closed
5 tasks done
aj-stein-gsa opened this issue Sep 10, 2024 · 4 comments · Fixed by #760
Closed
5 tasks done

FedRAMP needs a style guide for constraints #675

aj-stein-gsa opened this issue Sep 10, 2024 · 4 comments · Fixed by #760
Assignees
Labels
enhancement New feature or request

Comments

@aj-stein-gsa
Copy link
Contributor

aj-stein-gsa commented Sep 10, 2024

This is a ...

improvement - something could be better

This relates to ...

  • the FedRAMP OSCAL Registry
  • the FedRAMP OSCAL baselines
  • the Guide to OSCAL-based FedRAMP Content
  • the Guide to OSCAL-based FedRAMP System Security Plans (SSP)
  • the Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP)
  • the Guide to OSCAL-based FedRAMP Security Assessment Results (SAR)
  • the Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M)
  • the FedRAMP SSP OSCAL Template (JSON or XML Format)
  • the FedRAMP SAP OSCAL Template (JSON or XML Format)
  • the FedRAMP SAR OSCAL Template (JSON or XML Format)
  • the FedRAMP POA&M OSCAL Template (JSON or XML Format)
  • the FedRAMP OSCAL Validations

User Story

As a developer on the FedRAMP OSCAL constraints, I would like a guide for how to design and implement Metaschema constraints, individually and how they combine together, to make it clear to FedRAMP staff and community contributors on how to add, change, or remove tests to conform with the preferred style of the program.

Goals

  • Clear guidelines on how a constraint should be formatted and implemented
  • Clear guidelines on how multiple constraints should be organized

Dependencies

No response

Acceptance Criteria

  • All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.

Other information

Based on conversation from today's standup #610 and #669.

@aj-stein-gsa
Copy link
Contributor Author

Given receptivity and interest in #720 and review of #735. I would say we will need to start this guide up to address that first style requirement if approved.

@aj-stein-gsa
Copy link
Contributor Author

ADR merged, no longer blocked, we can move forward with this.

@aj-stein-gsa
Copy link
Contributor Author

I am going to start a branch in develop to get this work moving as it caused some confusion that led to my PR review and discussion during #736.

/cc @Rene2mt if you are interested in collaborating on it, I set this up in the upstream repo so we can more easily co-edit/cross-edit once I set something up.

@aj-stein-gsa aj-stein-gsa moved this from 🔖 Ready to 🏗 In progress in FedRAMP Automation Oct 4, 2024
aj-stein-gsa added a commit that referenced this issue Oct 4, 2024
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!
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Oct 4, 2024
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Oct 7, 2024
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Oct 7, 2024
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Oct 7, 2024
aj-stein-gsa added a commit to aj-stein-gsa/fedramp-automation that referenced this issue Oct 7, 2024
aj-stein-gsa added a commit that referenced this issue Oct 23, 2024
Address missing feedback to @kyhu65867 from review that had not been
previously addressed by yours truly.
aj-stein-gsa added a commit that referenced this issue Oct 23, 2024
Address some feedback about wording and style  of the unique ID req.
aj-stein-gsa added a commit that referenced this issue Oct 23, 2024
Completely address feedback from @david-waltermire after checking for
final review of style guide left in the comment below.

#760 (comment)
aj-stein-gsa added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
@aj-stein-gsa aj-stein-gsa moved this from 👀 In review to 🚢 Ready to Ship in FedRAMP Automation Oct 23, 2024
@aj-stein-gsa
Copy link
Contributor Author

The automation work in #790 to wrap this up and automate the style guide, but the guide is complete.

@github-project-automation github-project-automation bot moved this from 🚢 Ready to Ship to ✅ Done in FedRAMP Automation Oct 24, 2024
aj-stein-gsa added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
wandmagic added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
wandmagic added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
wandmagic added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
Gabeblis added a commit to Gabeblis/fedramp-automation that referenced this issue 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 <[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]>
Gabeblis added a commit to Gabeblis/fedramp-automation that referenced this issue 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 <[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]>
Gabeblis added a commit to Gabeblis/fedramp-automation that referenced this issue 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 <[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]>
aj-stein-gsa added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>

* 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 <[email protected]>

* TODO

* Move style guide

* TODO

* add help-url

---------

Co-authored-by: A.J. Stein <[email protected]>
Co-authored-by: Rene Tshiteya <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: A.J. Stein <[email protected]>
wandmagic added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>

* 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 <[email protected]>

* TODO

* Move style guide

* TODO

* add help-url

---------

Co-authored-by: A.J. Stein <[email protected]>
Co-authored-by: Rene Tshiteya <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: A.J. Stein <[email protected]>
wandmagic added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>

* 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 <[email protected]>

* TODO

* Move style guide

* TODO

* add help-url

---------

Co-authored-by: A.J. Stein <[email protected]>
Co-authored-by: Rene Tshiteya <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: A.J. Stein <[email protected]>
wandmagic added a commit that referenced this issue 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 <[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 #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 <[email protected]>

* [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 <[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 #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 <[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 #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 <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: Gabeblis <[email protected]>
Co-authored-by: David Waltermire <[email protected]>

* 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 <[email protected]>

* TODO

* Move style guide

* TODO

* add help-url

---------

Co-authored-by: A.J. Stein <[email protected]>
Co-authored-by: Rene Tshiteya <[email protected]>
Co-authored-by: wandmagic <[email protected]>
Co-authored-by: David Waltermire <[email protected]>
Co-authored-by: A.J. Stein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants