Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sample output and commands not clealry distinguished in ZooKeeper StatefulSet task #21720

Closed
sftim opened this issue Jun 13, 2020 · 3 comments · Fixed by #22816
Closed

Sample output and commands not clealry distinguished in ZooKeeper StatefulSet task #21720

sftim opened this issue Jun 13, 2020 · 3 comments · Fixed by #22816
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language

Comments

@sftim
Copy link
Contributor

sftim commented Jun 13, 2020

This is a Bug Report

Problem:
Running ZooKeeper, A Distributed System Coordinator has some places where the sample output is syntax-highlighted as if it were Bourne shell code, when it isn't.

For example, this text from that page isn't shell code:

clientPort=2181
dataDir=/var/lib/zookeeper/data
dataLogDir=/var/lib/zookeeper/log
tickTime=2000
initLimit=10
syncLimit=2000
maxClientCnxns=60
minSessionTimeout= 4000
maxSessionTimeout= 40000
autopurge.snapRetainCount=3
autopurge.purgeInterval=0
server.1=zk-0.zk-hs.default.svc.cluster.local:2888:3888
server.2=zk-1.zk-hs.default.svc.cluster.local:2888:3888
server.3=zk-2.zk-hs.default.svc.cluster.local:2888:3888

Proposed Solution:
Revise the Markdown (https://github.com/kubernetes/website/blob/master/content/en/docs/tutorials/stateful-application/zookeeper.md) to remove the shell suffix from any ``` block opener that doesn't actually contain code people should type in and run.

Some blocks contain a mix of commands and output. Turn those into 2 separate blocks as per separate command from output.

Page to Update:
https://kubernetes.io/docs/tutorials/stateful-application/zookeeper/

Additional Information:
Slightly relevant: #21718

/language en
/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

This is a Bug Report

Problem:
Running ZooKeeper, A Distributed System Coordinator has some places where the sample output is syntax-highlighted as if it were Bourne shell code, when it isn't.

For example, this text from that page isn't shell code:

clientPort=2181
dataDir=/var/lib/zookeeper/data
dataLogDir=/var/lib/zookeeper/log
tickTime=2000
initLimit=10
syncLimit=2000
maxClientCnxns=60
minSessionTimeout= 4000
maxSessionTimeout= 40000
autopurge.snapRetainCount=3
autopurge.purgeInterval=0
server.1=zk-0.zk-hs.default.svc.cluster.local:2888:3888
server.2=zk-1.zk-hs.default.svc.cluster.local:2888:3888
server.3=zk-2.zk-hs.default.svc.cluster.local:2888:3888

Proposed Solution:
Revise the Markdown (https://github.com/kubernetes/website/blob/master/content/en/docs/tutorials/stateful-application/zookeeper.md) to remove the shell suffix from any ``` block opener that doesn't actually contain code people should type in and run.

Some blocks contain a mix of commands and output. Turn those into 2 separate blocks as per separate command from output.

Page to Update:
https://kubernetes.io/docs/tutorials/stateful-application/zookeeper/

Additional Information:
Slightly relevant: #21718

/language en
/good-first-issue

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.

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Jun 13, 2020
@SoumithKumarMudugonda
Copy link
Contributor

/assign

@McCoyAle
Copy link
Contributor

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants