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.

Sign up for GitHub

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

Jump to bottom

Feature/enforce help props #2

Closed
wants to merge 21 commits into from
Closed

Feature/enforce help props #2

wants to merge 21 commits into from

Conversation

wandmagic
Copy link

Committer Notes

in case you want to finish this effort

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

Gabeblis and others added 21 commits October 18, 2024 17:55
@Gabeblis
Add props to each constraint that has sufficient existing documentati…
13e07fd 
…on (GSA#792)
@aj-stein-gsa @Rene2mt
@wandmagic @Gabeblis @david-waltermire
Create style guide for FedRAMP OSCAL Constraints (GSA#760)
1b69dca 
* Remove FedRAMP namespace from 'data-center' props (GSA#795)

* Hotfix/info (GSA#780)

* fix informational constraint handling and make ssp-all valid correct

* revert external constraint changes

* Update fedramp-external-constraints.xml

* Update fedramp_extensions_steps.ts

* update info handling

* Update fedramp-external-constraints.xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update fedramp-external-constraints.xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update fedramp-external-constraints.xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update fedramp-external-constraints.xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update src/validations/constraints/fedramp-external-constraints.xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update src/validations/constraints/fedramp-external-constraints.xml

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* Update dev-constraint.js

---------

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* [skip ci] Create style guide doc for GSA#675

* [skip ci] FSCR-1 re external constraints for GSA#675

* [skip ci] FCSR-1, woops, need formal name for GSA#675

* [skip ci] Tweak FCSR-1 anchor ID in GSA#675

* [skip ci] Stop header hacks for IDs in GSA#675

I read more about these techniques than I would like, but none of them
appear to work effectively for making anchors like `#fcsr-1` without
adding other content to the anchor which I would like to avoid.

https://gist.github.com/asabaylus/3071099?permalink_comment_id=3895584

Either it never worked or something changed. Oh well!

* [skip ci] Add FCSR-2 on context sorting for GSA#675

* [skip ci] Add FCSR-3 about alpha sorting for GSA#675

* [skip ci] Add FCSR-4 to require help-url for GSA#675

* [skip ci] Adjust title from style guide to dev style guide per Rene's review

* [skip ci] Adjust grammar and style per Rene's review

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>

* [skip ci] @Rene2mt's feedback: add ID req for GSA#675

* [skip ci] @Rene2mt's feedback: level req for GSA#675

* [skip ci] @Rene2mt's review: why CRITICAL for GSA#675

* [skip ci] Woops, missed IDs for reqs for GSA#675

* [skip ci] Feedback: add message req for GSA#675

* [skip ci] Fix constraint path in examples for GSA#675

* [skip ci] Add remarks rec guidance for GSA#675

* [skip ci] Add @wandmagic's rec for FCSR-1 for GSA#675

* [skip ci] Add FCSR-10 re active voice for GSA#675

* [skip ci] Remove FCSR-10's incorrect only for GSA#675

* [skip ci] Add FCSR-11 about BCP14 words for GSA#675

* [skip ci] Add no-jargon req FCSR-12 for GSA#675

* [skip ci] Item, not sequence style req for GSA#675

* [skip ci] Add req for sequence ctx hints for GSA#675

* [skip ci] Add FCSR-15 re formal-names for GSA#675

* [skip ci] Remove anchor hack from FCSR-1 for GSA#675

* [skip ci] Wrap up kebab case IDs, reorder for GSA#675

* [skip ci] Fixes from @Rene2mt'2 review for GSA#675

* [skip ci] Add labels for rules in GSA#675

* [skip ci] Simplify rule titles for GSA#675

Follow feedback from @brian-ruf in his review.

* [skip ci] Finalize table index with reqs for GSA#645

* [skip ci] Limit informational constraints for GSA#675

* [skip ci] Feedback: FRR1 about OSCAL constraints, not Metaschema constraints

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Update FRR1 in table listing too

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Add space in status row of table for FRR2

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Add missing word to FRR3 title

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Improve the prose in FRR2 guidance

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Reorder statements in sentence of FRR2 guidance

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Clarify ambiguous wording in FRR5

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Correct typos in FRR6 formal name

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Make FRR7 formal name more explicit

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Improve FRR8 formal name

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Fix FRR8 formal name in table index

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Fix FRR9 formal name in table index

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Fix FRR9 formal name in table index

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Adjust FRR9 guidance to specify expect constraints

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Adjust FRR9 constraint examples for correct type

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Adjust FRR10 formal name to be more clear

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Fix FRR10 formal name in table index

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Make FRR11 formal name better sentence fragment

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Fix FRR11 above requirement text

Co-authored-by: David Waltermire <david.waltermire@gsa.gov>

* [skip ci] Adjust FedRAMP reqs prefix FCSR->FRR

Given related work in the program, I want to generalize the prefix to be
more general and global for all form of FedRAMP requirements down the
road.

* [skip ci] Add missing examples to FRR17 for GSA#675

* [skip ci] Align formal names, spacing for GSA#675

I had to fix up some of the formal names where Dave covered some of them
in many places, but not all. Also other suggestions add some space.

* [skip ci] Add level to many examples, finish GSA#675

* [skip ci] Fold longer bg info for reqs in GSA#675

* [skip ci] Clarify FRR1 bad example is bad in GSA#645

* [skip ci] Clarify context order examples for GSA#675

* [skip ci] Clarify case sorting for FRR3 in GSA#675

* [skip ci] Clean up explanation of FRR10 for GSA#675

* [skip ci] Fix typos in FRR13 and FRR15 for GSA#675

* [skip ci] FRR2 feedback from Kylie for GSA#675

* [skip ci] Reword FRR9 with Kylie's feedback in GSA#675

* [skip ci] Woops, FRR16 twice, no FRR17 for GSA#675

* [skip ci] Last call and let reqs in FRR18 for GSA#675

* [skip ci] Correct ID for FRR18 to anchor in table

Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>

* [skip ci] Offset req ID sequence

Per discussion with others on a call with leads and staff from both FR
branches, begin with an offset sequences and reserve the first 100 for
other uses for the time being.

/cc @kscarf1

* [skip ci] BCP14 keywords in GSA#675 summary text

* [skip ci] Tighten up summary text more for GSA#675

* [skip ci] Add back to top anchors for GSA#675

* [skip ci] Better grammar and flow for GSA#675 summary

* [skip ci] Improve FRR102 guidance text for GSA#675

* [skip ci] Capitalize and fix FRR110 title for GSA#675

* [skip ci] Fix poor grammar in FRR117 text for GSA#675

* [skip ci] Explicit docs URL in FRR104 for GSA#675

Address missing feedback to @kyhu65867 from review that had not been
previously addressed by yours truly.

* [skip ci] Fix FRR105 with feedback for GSA#675

Address some feedback about wording and style  of the unique ID req.

* [skip ci] Fix FRR103 spacing for GSA#675

Completely address feedback from @david-waltermire after checking for
final review of style guide left in the comment below.

GSA#760 (comment)

* [skip ci] Fix FRR108 conformant example for GSA#675

---------

Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov>
Co-authored-by: wandmagic <156969148+wandmagic@users.noreply.github.com>
Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov>
Co-authored-by: David Waltermire <david.waltermire@gsa.gov>
@wandmagic
introduce coverage for help text
b44d5f0
@wandmagic
only need the help uri
9614cd5
@wandmagic
add help uri
2e59e39
@wandmagic
introduce style guide constraint
d719b94
@wandmagic
Update fedramp_extensions.feature
801420d
@wandmagic
Update fedramp_extensions.feature
682a134
@wandmagic
remove jsdom filtering
cd4b309
@wandmagic
improve constraint style checking
c0c3c2f
@wandmagic
remove orphaned test
f5ea95f
@wandmagic
re introduce missing content
383daf2
@wandmagic
require message for expect constraints
9cdfb6d
@wandmagic
follow style guide more closely
0d04085
@wandmagic
only validate fedramp constraints with the style guide
983bc2b
@Gabeblis @wandmagic
Add props to each constraint that has sufficient existing documentati…
6eb8a57 
…on (GSA#792)
@wandmagic
re-introduce information-type-800-60-v2r1 & scaffold alphabetical con…
078507e 
…straint
@wandmagic
a fedramp help message MUST be all caps
da6262c
@wandmagic
rebase
02e0066
@wandmagic
Merge pull request #16 from wandmagic/feature-constraints-on-constraints
f8b658c 
Feature constraints on constraints
@wandmagic
Merge branch 'feature-constraints-style-guide' into feature/enforce-h…
07d4084 
…elp-props
@wandmagic wandmagic closed this Nov 7, 2024
Gabeblis added a commit that referenced this pull request Dec 17, 2024
@Gabeblis
Add approach #2
97114da
Gabeblis added a commit that referenced this pull request Dec 19, 2024
@Gabeblis
proceed with option #2
f994d8c
Gabeblis added a commit that referenced this pull request Dec 19, 2024
@Gabeblis
Add approach #2
88f5cc0
Gabeblis added a commit that referenced this pull request Dec 19, 2024
@Gabeblis
proceed with option #2
e2563ba
Gabeblis added a commit that referenced this pull request Dec 19, 2024
@Gabeblis
Add AC, AT, and AU constraints and tests. Add 'point to' feature to d…
7354a88 
…ev-constraint.js

Add CA, CM, and CP constraints and tests.

Add IA AND IR constraints and tests.

Add MA and MP constraints and tests

ADD PE, PL, and PS constraints and tests

Add RA constraint and tests

Add SA and SC constraints and tests

Add SI and SR constraints and tests

One invalid file for all control statements

Add approach #2

proceed with option #2

proceed with option #2
Gabeblis added a commit that referenced this pull request Dec 19, 2024
@Gabeblis
proceed with option #2
a4fae0e 
Add CA, CM, and CP constraints and tests.

Add IA AND IR constraints and tests.

Add MA and MP constraints and tests

ADD PE, PL, and PS constraints and tests

Add RA constraint and tests

Add SA and SC constraints and tests

Add SI and SR constraints and tests

One invalid file for all control statements

Add approach #2

proceed with option #2
Gabeblis added a commit that referenced this pull request Dec 26, 2024
@Gabeblis
proceed with option #2
ebf2226
Gabeblis added a commit that referenced this pull request Dec 30, 2024
@Gabeblis
Proceed with option #2
541e729
Gabeblis added a commit that referenced this pull request Dec 30, 2024
@Gabeblis
Proceed with option #2 (GSA#1002)
d8965c1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@wandmagic @Gabeblis @aj-stein-gsa