Heredoc snippets remove syntax coloring about website HOT 7 OPEN

We don't use code_sample for shell commands (it's for manifests).

However, you can copy just the FOO=Bar line into a text editor if you want. I get that people might like the computer to do more of the work, but I also think we should focus on our high priority issues ahead of any more work here.

from website.

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.

from website.

/language en
/sig docs

from website.

Our (existing) policy is to use downloadable manifests based on code_sample - see https://kubernetes.io/docs/contribute/style/hugo-shortcodes/#source-code-files

We have more work to do to get there. And, we might want to widen the scope of what you can copy; see #45910

Do you have an example of a particular snippet that you think should be done a different way to help learners @MatthewFallon ?

I personally am wary of encouraging people to copy and paste snippets as-is; see #45910 (comment)

from website.

/priority backlog
(ie, nothing higher)

from website.

/kind feature

from website.

Do you have an example of a particular snippet that you think should be done a different way to help learners @MatthewFallon ?

Hey @sftim 👋 yes looking at this section I see the following code snippet:

# Create a application.properties file
cat <<EOF >application.properties
FOO=Bar
EOF

cat <<EOF >./kustomization.yaml
configMapGenerator:
- name: example-configmap-1
  files:
  - application.properties
EOF

Which as commands holds no purpose other than:

1. Create text file application.properties with contents
2. Create yaml file kustomization.yaml with contents

There are multiple instances of this on that page, which really only serves the purpose of providing an easy copy paste as manually typing a heredoc command like such is kind of cumbersome to begin with haha.

I think a fair point on not wanting to encourage too much copy pasting using buttons as such 👍 I had figured that was the original intent based on content. In this case I think you're right that these commands would better be shown as two individual code_sample statements instead. I think many of the code snippets on this page just need to be modified to fit that format.

Will leave this here as clarification of the suggestion, and will potentially look into contributing the change myself if I find the time. Thanks for adding context! 👍 😄

from website.