-
Notifications
You must be signed in to change notification settings - Fork 1.6k
doc: fix formatting in mirroring task #16547
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
base: master
Are you sure you want to change the base?
Conversation
😊 Welcome! This is either your first contribution to the Istio documentation repo, or
Thanks for contributing! Courtesy of your friendly welcome wagon. |
Hi @msahihi. Thanks for your PR. I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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-sigs/prow repository. |
Changes are validated in https://deploy-preview-16547--preliminary-istio.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/ok-to-test
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This breaks the formatting of the page and does not actually change the copied text. I'm not sure how you're utilizing clipboard to get different text, but using both highlight + CTRL+C or the inline copy button added to the codeblock results in properly formatted scripts.
Look at how your changes break the style of the page between 3. Deploy the curl workload you’ll use to send requests to the httpbin service:
and 3. Deploy the httpbin Kubernetes service:
(your removal of the indents is also breaking the ordered numbering).
Thank you for the feedback.
I am checking https://deploy-preview-16547--preliminary-istio.netlify.app/latest/docs/tasks/traffic-management/mirroring/ and it is perfectly working. Code format for
On macOS, the
Not sure how I borked the format. This is the same format as the published one. Checking the published mirroring task I can see both but I will check failing lint test |
Because you unindented code blocks, it moves the code blocks to not be "under" the number... for example (and in the prelim further down the page), this is what it is supposed to look like Versus what your change looks like We indent code blocks to be under the ordered list item to keep the numbering consistent and to visually reflect that code block belongs to that step. |
@msahihi: The following test failed, say
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-sigs/prow repository. I understand the commands that are listed here. |
As an aside: we don't expect this to be easy, or fixable in this file. It's probably a bug in the tabset implementation. |
Yes, see : #15700 (comment) |
Description
Corrected improper formatting in bash code snippets within the Creating a default routing policy and Mirroring traffic to httpbin-v2 sections. Previously, copy-pasting these snippets would result in parsing errors like
This prevents users from directly using the provided examples.
This PR ensures the commands are directly usable.
Reviewers