search

openshift / compliance-operator

Operator providing OpenShift cluster compliance checks
Apache License 2.0
110 stars 110 forks source link

Revamp CRD docs #724

Closed JAORMX closed 3 years ago

JAORMX commented 3 years ago

This adds pictures and changes the ordering to show how we expect users to interact with the operator. This way, suites and scans are no longer on the top, and instead the more relevant objects to interact with are there.

It also divices the document in relevant sections depending on the classification of the object.

Signed-off-by: Juan Antonio Osorio Robles jaosorior@redhat.com

JAORMX commented 3 years ago

Pull-request updated, HEAD is now 8546ecb652ff0c71e65a13224d8b447b657970fc

openshift-ci[bot] commented 3 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JAORMX, jhrozek

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/openshift/compliance-operator/blob/master/OWNERS)~~ [JAORMX,jhrozek] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment