Skip to content

docs: CPLYTM-498 add document for sync-cac-content #434

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

Merged
merged 2 commits into from
Jan 27, 2025

Conversation

huiwangredhat
Copy link
Member

Description

Add the document for the CLI sync-cac-content.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

  • Test A
  • Test B

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@huiwangredhat huiwangredhat requested review from qduanmu and a team January 27, 2025 08:43
@huiwangredhat huiwangredhat changed the title doc: CPLYTM-498 add document for sync-cac-content docs: CPLYTM-498 add document for sync-cac-content Jan 27, 2025
@huiwangredhat huiwangredhat force-pushed the doc_sync-cac-content branch 3 times, most recently from cc8425a to 14a8eac Compare January 27, 2025 09:59
Copy link
Member

@hbraswelrh hbraswelrh left a comment

Choose a reason for hiding this comment

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

Looks great! I left a few minor comments, but otherwise LGTM.

- Populate CaC product information to Oscal component title and description
- Ensure OSCAL component control mappings are populated with rule and rule parameter data from CaC control files
- Create a validation component from SSG rules to check mappings
- Ensure OSCAL component definition implemented requirements is populated from control notes in control file
Copy link
Member

Choose a reason for hiding this comment

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

Nit-pick: Possibly rewording to "Ensure OSCAL Component Definition implemented requirements are populated from control notes in the control file. "

- Ensure OSCAL component control mappings are populated with rule and rule parameter data from CaC control files
- Create a validation component from SSG rules to check mappings
- Ensure OSCAL component definition implemented requirements is populated from control notes in control file
- Ensure implementation status of an implemented requirement in OSCAL component definitions is populated with the status from CaC control files
Copy link
Member

Choose a reason for hiding this comment

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

Nit-pick: Same comment to reword from "is populated" to "are populated."

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated.


## 1. Prerequisites

- Initialize the [trestlebot workplace](https://github.com/complytime/trestle-bot/blob/main/docs/tutorials/github.md#3-initialize-trestlebot-workspace).
Copy link
Member

Choose a reason for hiding this comment

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

Would this be trestlebot workspace instead of workplace? I am not sure, but wanted to ask.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, workspace. Good catch!

Signed-off-by: Sophia Wang <huiwang@redhat.com>
@huiwangredhat huiwangredhat merged commit 340ab57 into complytime:main Jan 27, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants