-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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
Easier kubectl download for Windows #3859
Conversation
Because Windows doesn't ship `curl` and doesn't process $(curl ...) shell expansion, it is better to provide a working link for it in example instead of OS X
make delimiters fit issue width, see kubernetes#3859
make delimiters fit issue width, see #3859
@techtonik I think we should use tabs to display the command and an example for each of the platforms. |
Where is the JS code that renders tabs? I found https://github.com/kubernetes/kubernetes.github.io/blob/master/docs/user-guide/kubectl/v1.6/tabvisibility.js but it doesn't seem to be the one. |
You can view the example here: https://kubernetes.io/docs/tabs-example/ The markdown for that page is here: https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master/docs/tabs-example.md The implementation is here: Basically, it's using jQuery UI Tabs: That js is included in all the pages:
|
Yes. That's what I was interested in. That markdown syntax is weird. I feel more comfortable just writing some HTML or even custom element to provide source quality and readability. It is that "Wikipedia problem" that its markup became more mystic than raw HTML. |
Wait, what specifically about the markdown syntax is weird? We would rather not have any custom JS or one-off HTML living in the repo. If you don't like the tabs implementation, we could work on refining it together. |
|
This is a good syntax for me to write tabs. It doesn't require me to know about template output capturing magic. |
Ok, that looks like a reasonable syntax, but how would we implement that in the markdown parser? (I'm still learning Jekyll, so I haven't gotten to how to extend it yet.) |
I am not aware of it either, but if we ditch the ability to write markdown in tabs, I think it should be possible to just provide custom syntax formatter. I replaced triple backticks with triple quotes below.
|
@techtonik This seems like more of a long-term project. Can you do me a favor an open an Issue for this. In the meantime, I would like to just use the existing tabs implementation w/ the liquid capture syntax. I can do this for install-kubectl.md pretty quickly if you'd like. |
@chenopis yes, that would help me to concentrate on other things. Maybe part of that is that I really like to compare install commands for different systems and with clickable tabs it is not that convenient. ) |
@techtonik Ok, no prob. I'll work on making the change today. Then I'll close this PR. |
@techtonik I've made the change. Take a look and let me know if this works for you. Cheers |
…netes/kubernetes.github.io into release-1.7 * 'release-1.7' of https://github.com/kubernetes/kubernetes.github.io: * 'master' of https://github.com/kubernetes/kubernetes.github.io: Implement PR #3859 with tabs
…hub.io into release-1.6 * 'master' of https://github.com/kubernetes/kubernetes.github.io: Implement PR #3859 with tabs
Oh, that's cool. I was about to complain that Documentation for Windows is wrong, because there is no |
Because Windows doesn't ship
curl
and doesn't process $(curl ...)shell expansion, it is better to provide a working link for it in example
instead of OS X
This change is