cert-manager / website

Source code for the cert-manager.io website, including project documentation
https://cert-manager.io
Apache License 2.0
53 stars 333 forks source link

Remove $ from bash code snippets #1513

Closed lindhe closed 2 months ago

lindhe commented 2 months ago

While $ is a good way to differentiate between a command and its output, it is best to leave it out whenever there is no output. This way, the user can copy the command by clicking the copy button on the rendered website without having to worry about the leading $ when pasting the command.

This was already the case for some snippets. This change removes the leading $ for some more snippets.

lindhe commented 2 months ago

Here's an example of what it looks like before my change:

Screenshot 2024-07-10 092421

The $ will be included if the users copies via the copy button in the web interface.

netlify[bot] commented 2 months ago

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
Latest commit 59ff413ceb3bccdac18f2599674331876bdc1537
Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/668e3994fdc8550008dd8ed9
Deploy Preview https://deploy-preview-1513--cert-manager.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

lindhe commented 2 months ago

Looks good:

image

cert-manager-prow[bot] commented 2 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wallrj

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/cert-manager/website/blob/master/OWNERS)~~ [wallrj] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment