Comments (7)
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.
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.
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:
- Create text file application.properties with contents
- 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.
Related Issues (20)
- [ja] Translate content/en/docs/reference/glossary/data-plane.md into Japanese HOT 4
- Update and add links to "Networking on Windows" doc HOT 2
- here is issue in main menu i can fix HOT 4
- Debugging DNS Resolution - "Are DNS endpoints exposed?" section uses kube-dns as example instead of coredns HOT 3
- Improve Accesibility HOT 4
- Problem with "Deploy and Access the Kubernetes Dashboard" HOT 5
- Malformed HTML in auto-generated page "Quantity" HOT 6
- "kubectl attach" command hangs without providing interactive shell following "Share Process Namespace between Containers in a Pod" task HOT 5
- Cloud provider integration blog has a minor version error HOT 3
- Wrong ansible group parameter used in "Kubernetes Setup Using Ansible and Vagrant" post HOT 6
- Improvement for k8s.io/docs/concepts/workloads/pods/init-containers/ HOT 5
- [pt-br] Rename and sync the content of pt-br/docs/reference/kubectl/cheatsheet/ HOT 5
- [ko] Translate content\en\docs\concepts\architecture\cgroups.md into Korean HOT 2
- Running Multiple Instances of Your App - contradicting instructions HOT 5
- [fr] Inactive and deprecated interactive tutorial in "Deploying an application" page HOT 5
- "Migrate Kubernetes Objects Using Storage Version Migration" is unclear HOT 4
- Kubernetes documentation search is not working HOT 3
- #sudo su Command line tool (kubectl) HOT 3
- [pt-br] Localize docs/tasks/access-application-cluster/create-external-load-balancer/ HOT 4
- Two notes in the pod-lifecyle page work not very well HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from website.