Skip to content

fix: remove shell prompt symbols from installation commands - #236

Open
schacherle wants to merge 1 commit into
shipwright-io:mainfrom
schacherle:feature/fix-installation-prompt-symbols
Open

schacherle wants to merge 1 commit into
shipwright-io:mainfrom
schacherle:feature/fix-installation-prompt-symbols

Conversation

@schacherle

Copy link
Copy Markdown

Changes

Removes the leading $ shell prompt symbol from bash code blocks in the installation guide. The $ was being included when users clicked the copy-to-clipboard button, so pasted commands either failed outright or required manually stripping the prompt character first.

Also fixes a stray ```bash $ fence typo on the webhook-cert setup block.

Related Issue

Fixes #218

Type of PR

/kind bug

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Kind label has been set
  • Release notes block has been filled in, or marked NONE

Release Notes

NONE

Copilot AI review requested due to automatic review settings July 10, 2026 15:48
@openshift-ci openshift-ci Bot added the kind/bug Categorizes issue or PR as related to a bug. label Jul 10, 2026
@pull-request-size pull-request-size Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 10, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation command snippets to remove the leading $ shell prompt character so the copy-to-clipboard behavior produces directly runnable commands. It also fixes a malformed code fence in the installation guide.

Changes:

  • Removed leading $ prompt symbols from shell command examples to prevent copy/paste failures.
  • Fixed an incorrect code fence (bash $ → bash) in the webhook-cert setup block.
  • Applied the same command-format cleanup to a few additional docs pages containing kubectl examples.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/getting-started/installation.md Removes $ from installation commands and fixes a broken bash fence so copied commands run as-is.
docs/build/buildstrategies.md Removes $ from kubectl/jq example commands to improve copy/paste usability.
docs/build/buildrun.md Removes $ from kubectl example commands while preserving the shown output.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@schacherle
schacherle force-pushed the feature/fix-installation-prompt-symbols branch from ef0a63a to c724295 Compare July 10, 2026 16:10

@HeavyWombat HeavyWombat left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for bringing it up. I totally understand the copy feature being useless here is bad. On the other side, the "$" is usually used when you have a command and output. So the copy would copy the command output as well, wouldn't it? If it's like that, we would actually need to separate the command and the output to make it useful.

Comment thread docs/getting-started/installation.md
Comment thread docs/build/buildrun.md
Comment thread docs/build/buildstrategies.md
@IrvingMg

IrvingMg commented Aug 2, 2026

Copy link
Copy Markdown
Member

Hi @schacherle ,

As mentioned above, could you update it to separate the command from its output? This would allow us to remove the “$” from the command without causing any issues.

The `$` prefix in code blocks was being copied along with the
command, breaking the click-to-copy button.

Fixes shipwright-io#218

Signed-off-by: Ernst Schacherl <git+shipwright@schacherl.dev>
@schacherle
schacherle force-pushed the feature/fix-installation-prompt-symbols branch from c724295 to 67c14c3 Compare August 2, 2026 17:45
@pull-request-size pull-request-size Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 2, 2026
@schacherle

Copy link
Copy Markdown
Author

Thanks for bringing it up. I totally understand the copy feature being useless here is bad. On the other side, the "$" is usually used when you have a command and output. So the copy would copy the command output as well, wouldn't it? If it's like that, we would actually need to separate the command and the output to make it useful.

I've updated it to align with https://kubernetes.io/docs/contribute/style/style-guide/#don-t-include-the-command-prompt, separating the prompt from the output.

@schacherle
schacherle requested a review from adambkaplan August 2, 2026 17:48

@IrvingMg IrvingMg 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

Thanks!

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Aug 9, 2026
@IrvingMg

Copy link
Copy Markdown
Member

/approve

@openshift-ci

openshift-ci Bot commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: IrvingMg
Once this PR has been reviewed and has the lgtm label, please assign otaviof 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

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

Labels

kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. 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.

[DOCS] remove the $ symbol from the code snippets in installation.md

6 participants