Skip to content

tutorials: update readability#722

Merged
yuumasato merged 1 commit intoComplianceAsCode:masterfrom
sebrandon1:update_tutorial_bash
Sep 29, 2025
Merged

tutorials: update readability#722
yuumasato merged 1 commit intoComplianceAsCode:masterfrom
sebrandon1:update_tutorial_bash

Conversation

@sebrandon1
Copy link

Updates the copy/paste functionality in the tutorial to be easier to copy things that need to be pasted from the tutorial.

Improvements to command formatting:

  • Replaced inline commands with properly formatted bash code blocks for all oc create and oc get commands to improve readability and consistency. [1] [2]
  • Added yaml code blocks to clearly separate command outputs from commands, enhancing the tutorial's clarity. [1] [2]

Enhancements to output examples:

  • Updated output examples to use distinct bash and yaml blocks for better differentiation between commands and their results. [1] [2]
  • Included additional explanatory notes and examples for verifying deployments and troubleshooting potential issues with ClusterServiceVersion and InstallationPlan objects.

@openshift-ci openshift-ci bot requested review from BhargaviGudi and yuumasato May 20, 2025 19:16
@openshift-ci
Copy link

openshift-ci bot commented May 20, 2025

Hi @sebrandon1. Thanks for your PR.

I'm waiting for a ComplianceAsCode member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@yuumasato
Copy link
Member

/ok-to-test

@yuumasato yuumasato self-assigned this Jul 7, 2025
@openshift-ci
Copy link

openshift-ci bot commented Jul 7, 2025

@sebrandon1: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-rosa 30bac5d link true /test e2e-rosa

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@yuumasato yuumasato added this to the 1.8.0 milestone Sep 29, 2025
Copy link
Member

@yuumasato yuumasato left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Sep 29, 2025
@yuumasato yuumasato merged commit fae5709 into ComplianceAsCode:master Sep 29, 2025
14 of 20 checks passed
@openshift-ci
Copy link

openshift-ci bot commented Sep 29, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sebrandon1, yuumasato

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants