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

display of flag, double hyphen, parser upgrade #20915

Closed
kbhawkey opened this issue May 12, 2020 · 8 comments
Closed

display of flag, double hyphen, parser upgrade #20915

kbhawkey opened this issue May 12, 2020 · 8 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@kbhawkey
Copy link
Contributor

This is a Bug Report
Double hyphen literal characters are not displaying correctly when embedded in <code> element.

Problem:
Previously, the docs site turned off the BlackFriday parser smartDashes setting (config.toml).

With the recent change to Hugo 0.70.0 (Goldmark parser), the dashes are no longer displaying
as dashes when the command string is embedded in the <code> element.

One affected page:
https://kubernetes.io/docs/reference/kubectl/overview/#operations

Proposed Solution:
Investigate whether the parser can be configured or determine how to display the dashes by removing the use of <code> elements.

For additional information, see pull requests #20848, #20909.

@kbhawkey kbhawkey changed the title display of flag double hyphen, parser upgrade display of flag, double hyphen, parser upgrade May 12, 2020
@sftim
Copy link
Contributor

sftim commented May 12, 2020

/kind bug
/priority important-soon

because people copy-and-paste from that page a lot.

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels May 12, 2020
@sftim
Copy link
Contributor

sftim commented May 21, 2020

Relates to #20335

@neolit123
Copy link
Member

i think we got close to a dozen reports about this already.

@kbhawkey
Copy link
Contributor Author

kbhawkey commented Jun 9, 2020

@neolit123 , Did you see/review PR #21272?

@neolit123
Copy link
Member

i think i saw it, yes. is there a reason it's not merged yet?

@kbhawkey
Copy link
Contributor Author

kbhawkey commented Jun 9, 2020

i think i saw it, yes. is there a reason it's not merged yet?

Not that I know of

@tengqm
Copy link
Contributor

tengqm commented Jun 14, 2020

Things all look good now. Closing this.
/close

@k8s-ci-robot
Copy link
Contributor

@tengqm: Closing this issue.

In response to this:

Things all look good now. Closing this.
/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Development

No branches or pull requests

5 participants