Exercise: Read the docs 📚

[github-actions]

Read the docs 📚

👋 Hey there @beatrizmcouto! Welcome to your Skills exercise!

Get started by reading the supporting documentation 🍮

As you complete each step, I will respond in the comments to:

• check your work and give feedback
• share next steps
• occasionally share tips
• congratulate you when you finish!

Good luck and have fun!
- Mona

[github-actions]

📚 Reading creme-brulee Course Documentation

This is the first step of the learning course. Get started by reviewing the docs that will set the stage for your learning journey within the creme-brulee project.

✅ Mandatory Review Materials for Course Completion

Ensure you've reviewed these foundational resources for your success in the course.

Topic	Where you can find the docs
ComplianceAsCode/content	docs/CAC-CONTENT.md , docs/cac-content.md
ComplianceAsCode/oscal-content	docs/oscal-content.md
complyscribe repository	docs/complyscribe.md
complyctl repository	docs/complyctl.md
Policy as Code	docs/POLICY-AS-CODE.md , docs/policy-as-code.md
CNCF	docs/CNCF.md
Compliance Trestle	docs/TRESTLE-OVERVIEW.md

Document your notes in a GitHub issue like this. Duplicate the tab in your browser to take notes. Ensure you select "Learning course issue template" when opening your issue.

Reference the manual_steps.md for additional context on opening an issue to take notes.

📝 Take the Self-Assessment

Once you've thoroughly reviewed all the documentation above, take this short self-assessment. Good luck! 🚀

Comment the link to the issue that you opened once you're done taking the self-assessment.

[github-actions]

Please, follow the steps above.
I'll watch your progress in the background to provide feedback. 🧐

[github-actions]

Complete the Read the Docs self-assessment. This should be completed after Step 1: Read the Docs. Did you review the OSCAL for Compliance Managers recording and complete the GitHub Skills prerequisite courses? Those must be finished prior to this quiz. If not, start from the beginning here.

[github-actions]

Add a comment below linking your notes from Step 1 ✏️. Then start Step 2: Practice Communicating using Markdown and Git .

[beatrizmcouto]

#2

[github-actions]

🎉🎉🎉 Nice work! Everything is perfect! 🎉🎉🎉
Preparing content for step 2! One moment... 🤓

[github-actions]

Step 2: Practice Communicating using Markdown and Git

You should've completed the Communicate Using Markdown GitHub Skills course as a pre-requisite.

What you'll need

After completing Step 1: Read the docs you'll need to copy the link to the exercise issue and include it in the Pull request.

Follow the help guide for creating issues.

---

Getting Started

Follow the steps in the manual_steps.md for an in-depth walkthrough and example of editing content in the markdown/ folder.

1. Create a New Branch: In your copy of the learning course, create a new branch named learn-complytime/step-2.
2. Switch Branches: Switch to the learn-complytime/step-2 branch. This is where you'll start working with Git and Markdown.
3. Navigate and Review: Go to the markdown/ folder and review its contents. You'll find catalogs, profiles, and component definitions that were initialized by complyscribe.
   • Editing Example: The in-depth walkthrough in the manual steps provides an example of editing Markdown in the markdown/component-definitions/My-Test-Component/My-Test-Component/rhel10-anssi-enhanced/r1/r1.md file. Use this as a guide to make changes to the control implementations in the Component Definitions. Directions are hidden until you begin editing the Markdown file.
4. Commit Your Changes: Commit your changes to your learn-complytime/step-2 branch. You can make several commits as you work.
5. Open a Pull Request: Open a Pull Request and update its description to clearly explain the changes you've made in the Markdown files.
6. Submit Your Work: Copy the link to your Pull Request and submit it in the self-assessment.
7. Keep Practicing!: There's no limit to how many times you can retry this exercise. Simply follow the steps in the manual steps again.

---

What You'll Submit

The self-assessment will require submission of the link to your Pull Request opened for changes to OSCAL Component Definitions.

Edit a minimum of three Component Definitions. Separate each edit by commit. The Pull Request will include all commits published on the learn-complytime/step-2 branch.

RHEL10 ANSSI Enhanced Component Definition Example

---

r1 - [REPLACE_ME] Hardware Support

Control Statement

It is recommended to apply the configuration recommendations for Hardware support mentioned in ANSSI DAT-24.

---

What is the solution and how is it implemented?

Making an edit here for the control implementation description for r1.

Rules:

• rule-r1

Implementation Status: planned

---

[github-actions]

Please, follow the steps above.
I'll watch your progress in the background to provide feedback. 🧐

[github-actions]

Complete the self-assessment. This should be after you have completed Step 2: Practice Communicating using Markdown and Git..

[github-actions]

🎉🎉🎉 Nice work! Everything is perfect! 🎉🎉🎉
Now, let's do a quick review!

[github-actions]

Review 🎉🔎

Congratulations! You've completed the creme-brulee ComplyTime learning course and learned a lot about the supporting projects. You learned about the projects that build the foundation for ComplyTime tools and how to edit OSCAL Component Definitions in Markdown. You gained Git Flow experience through creation of branches, Pull Requests, and Markdown content. You're encouraged to continue your lasting learning journey through expanding your knowledge on Markdown and Git Flow.

Here's a recap of your accomplishments:

• Understood ComplyTime's Foundation: You now have a solid grasp of the core projects that underpin ComplyTime's powerful tools.
• Markdown & Git Flow Pro: You've learned how to edit OSCAL Component Definitions using Markdown and gained practical Git Flow experience by creating branches and Pull Requests.
• GitHub Savvy: You're more comfortable interacting with GitHub, particularly with Issues and Pull Requests.
• Compliance Automation Insights: You've explored the open-source projects driving automated compliance management workflows.
• Hands-on Experience: You've actively taken notes on ComplyTime projects and tools using Markdown and Git Flow, and even updated OSCAL Component Definitions and opened a Pull Request!
• ComplyScribe Knowledge: You understand the ComplianceAsCode/oscal-content repository and its two-way synchronization with ComplianceAsCode/content thanks to complyscribe.

What's Next on Your Learning Journey? 🚀

Your learning doesn't have to stop here! Here are a few ways to continue building on your new skills:

• Review Your Notes: Take another look at your personal copy of the creme-brulee ComplyTime learning course. You can find the issue that was automatically created when you started the exercise under the "Closed" tab in the "Issues" section.
• Practice Makes Perfect: Feel free to redo this exercise as many times as you like! Since this is a public repository template, you have unlimited opportunities to practice and solidify your understanding.
• Ask questions: The Slack channel for the learning course will be #learn-complytime

[github-actions]

Congratulations @beatrizmcouto! You finished the exercise! 🎉🎉🎉

We've updated the repository with a couple changes to highlight your success!

Return to the repository home page to see your progress!