Issue in copy-pasting snippets in terminal having comments

[erikh]

In the docs, the following segment is in a section of code:

# If the folder `/etc/apt/keyrings` does not exist, it should be created before the curl command, read the note below.
# sudo mkdir -p -m 755 /etc/apt/keyrings
curl -fsSL https://pkgs.k8s.io/core:/stable:/v1.29/deb/Release.key | sudo gpg --dearmor -o /etc/apt/keyrings/kubernetes-apt-keyring.gpg

If pasted in some shells (notably, zsh), where # is not a comment character at the beginning of the line, /etc/apt/keyrings is executed in a shell due to the backticks. It does nothing of course, but kind of sent my brain for a loop for a second.

Given that OS X shells these days are defaulted to zsh, seems like something worthy of concern to avoid in the future, as I could easily see others embedding actual commands in the comments which would get executed.

That said, thank you for maintaining such a wonderful resource, and have a good day.

[k8s-ci-robot]

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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/test-infra repository.

[dipesh-rawat]

Page reported in issue (based on the issue title): https://kubernetes.io/docs/tasks/tools/install-kubectl-linux
/language en

[adityasamant25]

Hi @erikh ,
What could be an option? Perhaps to move the comment lines outside the code block?

Also a side note,
This style of combining comments with the command to be executed within a block is seen at multiple pages throughout the site. So the issue being raised is not local to this page.

[erikh]

Well, I think the ideal option would be to include the comments but use another method of describing commands and literal locations. That said, I cannot think of a "better" syntax for this that doesn't really create the same problem. Perhaps that is the best approach, or at least don't make it part of the copied content. Is that a sensible approach?

…

On Tuesday, January 23rd, 2024 at 8:37 PM, adityasamant25 ***@***.***> wrote: Hi ***@***.***(https://github.com/erikh) , What could be an option? Perhaps to move the comment lines outside the code block? Also a side note, This style of combining comments with the command to be executed within a block is seen at multiple pages throughout the site. So the issue being raised is not local to this page. — Reply to this email directly, [view it on GitHub](#44866 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AAAET26262FCMVKC7SUDQZDYQCFXJAVCNFSM6AAAAABCH4TC7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBXGM3DEOBVGY). You are receiving this because you were mentioned.Message ID: ***@***.***>

[erikh]

sorry I really quickly wanted to expand on this: perhaps leave the comments in the page as they are, and modify the "copy to clipboard" function to fill the clipboard with the content minus comments that start at a line boundary. This way, the flow would be preserved for readers, you'd need to do a lot less copy editing, and the copied result would be safer for some users.

…

On Tuesday, January 23rd, 2024 at 8:41 PM, Erik Hollensbe (OSS) ***@***.***> wrote: Well, I think the ideal option would be to include the comments but use another method of describing commands and literal locations. That said, I cannot think of a "better" syntax for this that doesn't really create the same problem. Perhaps that is the best approach, or at least don't make it part of the copied content. Is that a sensible approach? On Tuesday, January 23rd, 2024 at 8:37 PM, adityasamant25 ***@***.***> wrote: > Hi ***@***.***(https://github.com/erikh) , > What could be an option? Perhaps to move the comment lines outside the code block? > > Also a side note, > This style of combining comments with the command to be executed within a block is seen at multiple pages throughout the site. So the issue being raised is not local to this page. > > — > Reply to this email directly, [view it on GitHub](#44866 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AAAET26262FCMVKC7SUDQZDYQCFXJAVCNFSM6AAAAABCH4TC7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBXGM3DEOBVGY). > You are receiving this because you were mentioned.Message ID: ***@***.***>

[erikh]

... for some reason I mis-remembered a copy tool, I'm sorry about that.

…

On Tuesday, January 23rd, 2024 at 8:48 PM, Erik Hollensbe (OSS) ***@***.***> wrote: sorry I really quickly wanted to expand on this: perhaps leave the comments in the page as they are, and modify the "copy to clipboard" function to fill the clipboard with the content minus comments that start at a line boundary. This way, the flow would be preserved for readers, you'd need to do a lot less copy editing, and the copied result would be safer for some users. On Tuesday, January 23rd, 2024 at 8:41 PM, Erik Hollensbe (OSS) ***@***.***> wrote: > Well, I think the ideal option would be to include the comments but use another method of describing commands and literal locations. That said, I cannot think of a "better" syntax for this that doesn't really create the same problem. > > Perhaps that is the best approach, or at least don't make it part of the copied content. Is that a sensible approach? > > On Tuesday, January 23rd, 2024 at 8:37 PM, adityasamant25 ***@***.***> wrote: > >> Hi ***@***.***(https://github.com/erikh) , >> What could be an option? Perhaps to move the comment lines outside the code block? >> >> Also a side note, >> This style of combining comments with the command to be executed within a block is seen at multiple pages throughout the site. So the issue being raised is not local to this page. >> >> — >> Reply to this email directly, [view it on GitHub](#44866 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AAAET26262FCMVKC7SUDQZDYQCFXJAVCNFSM6AAAAABCH4TC7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBXGM3DEOBVGY). >> You are receiving this because you were mentioned.Message ID: ***@***.***>

[aj11anuj]

/retitle Issue in copy-pasting snippets in terminal having comments
/sig docs
/kind feature

This issue is related to problem in copy-pasting snippets with comments in terminal. It doesn't seem a page or language specific issue.
/remove-language en

[Ritikaa96]

/area web-development

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[Ritikaa96]

I think this is worth working on as an issue.
/remove-lifecycle rotten