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

Re-add command line tools reference #8421

Merged
merged 13 commits into from
May 11, 2018
Merged

Re-add command line tools reference #8421

merged 13 commits into from
May 11, 2018

Conversation

zacharysarah
Copy link
Contributor

@zacharysarah zacharysarah commented May 8, 2018

This PR re-adds CLI tools reference to mimic the structure in v1.10.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 8, 2018
@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 8, 2018
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented May 8, 2018

Deploy preview for kubernetes-io-master-staging ready!

Built with commit faa7d14

https://deploy-preview-8421--kubernetes-io-master-staging.netlify.com

@zacharysarah zacharysarah changed the title [WIP] Re-add command line tools reference Re-add command line tools reference May 8, 2018
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 8, 2018
@zacharysarah
Copy link
Contributor Author

/assign @steveperry-53

@zacharysarah
Copy link
Contributor Author

There are some syntax bits sticking out in individual files, but the overall structure and navigation work.
https://deploy-preview-8421--kubernetes-io-master-staging.netlify.com/docs/reference/

@zacharysarah zacharysarah added this to the Hugo Migration milestone May 8, 2018
@steveperry-53
Copy link
Contributor

@steveperry-53
Copy link
Contributor

@zacharysarah, The structure you've set up looks good. I see that you have not put theses inside a generated folder. Maybe that's just the way it needs to be in our Hugo environment.

@chenopis, Thoughts about not having a generated folder.

@zacharysarah
Copy link
Contributor Author

@bep 👋 Can you shed some light on why the table HTML in kubelet.md renders as a code sample?

For reference, here's how it rendered in v1.10 in Jekyll.

@bep
Copy link
Contributor

bep commented May 8, 2018

@zacharysarah hard to tell without actually testing this, but if the file is 90+% HTML, why not create it as a *.html file and jump around this problem.

@steveperry-53
Copy link
Contributor

steveperry-53 commented May 8, 2018

@zacharysarah I think all you need is to add </tbody> and </table> at the bottom of each page. See this commit and this page in the preview.

@tengqm
Copy link
Contributor

tengqm commented May 9, 2018

According to Steve's findings, the files pushed are not the latest version. Please pick the files from another commit (#8283). The contents pushed are not from the release-1.10 branch due to issues in the doc generator.

@zacharysarah
Copy link
Contributor Author

@tengqm Thanks for the pointer--I can't cherry-pick the commit, obviously, but I will manually copy the file contents.

@steveperry-53 Thanks for the tip! 🎯

@zacharysarah
Copy link
Contributor Author

zacharysarah commented May 10, 2018

@tengqm, @steveperry-53 I updated the references files with content from #8283. Can you please verify that this looks good and is ready to go?

@steveperry-53
Copy link
Contributor

I'm going to go ahead and approve/lgtm this in the interest of getting these files into the docs as soon as possible. @tengqm, If you find any problems, let's address them in a followup PR.
/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 11, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: steveperry-53

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 11, 2018
@k8s-ci-robot k8s-ci-robot merged commit c35de70 into kubernetes:master May 11, 2018
@zacharysarah zacharysarah deleted the add-cli-tools-ref branch May 11, 2018 17:31
mbert pushed a commit to mbert/website that referenced this pull request May 15, 2018
* Add CLI tools ref MD files

* Add TOC

* Add TOC weights

* Tweaking table formatting

* Update kube-scheduler.md

* Updates to kubelet

* Use latest version of docs (v1.10)

* Update docs to v1.10

* Tweak whitespace

* Update docs to v1.10

* Update docs to v1.10

* Update docs to v1.10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants