Skip to content

docs: remove shell prompts from command blocks - #296

Open
Ava-91 wants to merge 4 commits into
shipwright-io:mainfrom
Ava-91:fix/remove-shell-prompts
Open

Ava-91 wants to merge 4 commits into
shipwright-io:mainfrom
Ava-91:fix/remove-shell-prompts

Conversation

@Ava-91

@Ava-91 Ava-91 commented Sep 4, 2026

Copy link
Copy Markdown

Description

Removes the unnecessary leading $ shell prompts from command blocks throughout the documentation.

These prompts are especially annoying in click-to-copy blocks because the $ can be copied as part of the command.

Changes

  • Removed leading $ prompts from command examples in:

    • README.md
    • docs/development/local-development.md
    • docs/development/olm-development.md
    • docs/development/releasing.md
  • Preserved actual shell variable syntax such as $version and ${...}.

Closes #295

NONE

@pull-request-size pull-request-size Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 4, 2026
@openshift-ci openshift-ci Bot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Sep 4, 2026
@openshift-ci

openshift-ci Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sayan-biswas for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@openshift-ci openshift-ci Bot added release-note-none and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Sep 4, 2026

@kaizakin kaizakin left a comment

Copy link
Copy Markdown
Member

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 Indicates that a PR is ready to be merged. label Sep 7, 2026
@kaizakin

Copy link
Copy Markdown
Member

Hey @Ava-91 please sign your commits

@Ava-91
Ava-91 force-pushed the fix/remove-shell-prompts branch from 20fdd6b to 1dd6a77 Compare September 17, 2026 08:31
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 17, 2026
@openshift-ci

openshift-ci Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

@Ava-91

Ava-91 commented Sep 17, 2026

Copy link
Copy Markdown
Author

Hey @kaizakin, I’ve re-signed all 4 commits as requested and force-pushed the updated branch. All commits are now GitHub Verified.

Could you please re-review the updated commits and add /lgtm again when you get a chance? Thanks!

@kaizakin

Copy link
Copy Markdown
Member

@Ava-91 please sign your commits using the signoff flag

you can do that to a new commit by git commit -s -m "message" or git commit --amend -s to an existing commit

Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com>
Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com>
Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com>
Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com>
@Ava-91
Ava-91 force-pushed the fix/remove-shell-prompts branch from 1dd6a77 to ca3f7cb Compare September 17, 2026 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-note-none size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Why do we have $ throughout the docs?

3 participants