Skip to content

docs: rewrite getting started guide with explicit OpenSCAP setup - #83

Open
trevor-vaughan wants to merge 1 commit into
mainfrom
fix/65-openscap-path
Open

docs: rewrite getting started guide with explicit OpenSCAP setup#83
trevor-vaughan wants to merge 1 commit into
mainfrom
fix/65-openscap-path

Conversation

@trevor-vaughan

Copy link
Copy Markdown
Member
  • Replace complyctl init as the primary setup path with a full
    complytime.yaml example (policy URL, target, profile variable)
  • Add dnf install command for openscap-scanner and scap-security-guide
  • Fix provider cp path (drop bin/ prefix to match release artifacts)
  • Document the profile variable and how to list available SSG profiles
  • Add datastream override for distros where auto-detection fails
  • Link to provider releases, source build instructions, and config docs
  • Use concrete policy ID (cis-fedora-l1-server) in all scan examples

Fixes #65

Signed-off-by: Trevor Vaughan tvaughan@redhat.com

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

CRAP Load Analysis

No Go code changes detected in this PR. No CRAP impact.

@trevor-vaughan
trevor-vaughan marked this pull request as ready for review July 6, 2026 19:30
@trevor-vaughan
trevor-vaughan requested a review from a team as a code owner July 6, 2026 19:30
em-redhat
em-redhat previously approved these changes Jul 29, 2026

@em-redhat em-redhat left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Clean documentation fix that directly resolves #65. All CI checks pass. The PR replaces the abstract complyctl init workflow with a concrete, copy-pasteable complytime.yaml including the required profile variable, fixes the provider cp path, adds the dnf install command, and documents the datastream override. Two LOW optional suggestions below.

This review was generated by /review-pr (AI-assisted).

Comment thread content/docs/getting-started/_index.md
Comment thread content/docs/getting-started/_index.md
- Replace complyctl init as the primary setup path with a full
  complytime.yaml example (policy URL, target, profile variable)
- Add dnf install command for openscap-scanner and scap-security-guide
- Fix provider cp path (drop bin/ prefix to match release artifacts)
- Document the profile variable and how to list available SSG profiles
- Add datastream override for distros where auto-detection fails
- Link to provider releases, source build instructions, and config docs
- Use concrete policy ID (cis-fedora-l1-server) in all scan examples

Fixes #65

Assisted-By: Claude Opus 4.6
Signed-off-by: Trevor Vaughan <tvaughan@redhat.com>
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.

Getting Started: the openscap path needs a profile target variable the page never mentions

2 participants