fix: remove shell prompt symbols from installation commands - #236
schacherle wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
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.
ef0a63a to
c724295
Compare
HeavyWombat
left a comment
There was a problem hiding this comment.
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.
|
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>
c724295 to
67c14c3
Compare
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. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: IrvingMg The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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
Release Notes