Skip to content

[WIP] testing restyled kubectl ref#15742

Closed
kbhawkey wants to merge 4 commits intokubernetes:masterfrom
kbhawkey:testing-kubectl-ref-style
Closed

[WIP] testing restyled kubectl ref#15742
kbhawkey wants to merge 4 commits intokubernetes:masterfrom
kbhawkey:testing-kubectl-ref-style

Conversation

@kbhawkey
Copy link
Copy Markdown
Contributor

@kbhawkey kbhawkey commented Aug 8, 2019 •
edited
Loading

  • Testing an initial, cleaned up, simple generation of kubectl reference docs
  • Needs further styling; needs navigation improvement; uses hugo to generate html and better integration with k8s/docs
  • I have been separately testing a 3 column layout for reference docs that reuses the base docs layout and sidebar, but adds the inline page toc to the right hand side of the page. Ideas taken from the docsy theme.
  • Also envision a new shortcode to create the version/copyright info.
  • Comments welcome

@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. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 8, 2019
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Aug 8, 2019
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Aug 8, 2019

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign kbhawkey
You can assign the PR to them by writing /assign @kbhawkey in a comment when ready.

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

Details 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

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 8, 2019 •
edited
Loading

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

Built with commit 509fadb

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

@kbhawkey
Copy link
Copy Markdown
Contributor Author

kbhawkey commented Aug 8, 2019

/cc @tengqm

@k8s-ci-robot k8s-ci-robot requested a review from tengqm August 8, 2019 12:37
@kbhawkey
Copy link
Copy Markdown
Contributor Author

kbhawkey commented Aug 8, 2019

Preview:
https://deploy-preview-15742--kubernetes-io-master-staging.netlify.com/docs/reference/kubectl/kubectl-reference/alpha/

@kbhawkey kbhawkey mentioned this pull request Aug 16, 2019
Closed
@tengqm
Copy link
Copy Markdown
Contributor

tengqm commented Aug 17, 2019

I like this idea.

@kbhawkey kbhawkey force-pushed the testing-kubectl-ref-style branch 2 times, most recently from c80a0c1 to 394b765 Compare August 29, 2019 14:35
@kbhawkey kbhawkey force-pushed the testing-kubectl-ref-style branch from 394b765 to 509fadb Compare September 5, 2019 15:51
@kbhawkey
Copy link
Copy Markdown
Contributor Author

kbhawkey commented Sep 25, 2019

Closing this PR. The kubectl reference build generation changes depend upon website layout updates (can use the existing tool reference layout). I think the embedded, top, page links toc is not as good for longer page navigation as the separate, right hand, page links toc.
/close

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Sep 25, 2019

@kbhawkey: Closed this PR.

Details

In response to this:

Closing this PR. The kubectl reference build generation changes depend upon website layout updates (can use the existing tool reference layout). I think the embedded, top, page links toc is not as good for longer page navigation as the separate, right hand, page links toc.
/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.

@kbhawkey kbhawkey deleted the testing-kubectl-ref-style branch July 30, 2020 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jimangel jimangel Awaiting requested review from jimangel

@zhangxiaoyu-zidif zhangxiaoyu-zidif Awaiting requested review from zhangxiaoyu-zidif

@tengqm tengqm Awaiting requested review from tengqm

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kbhawkey @k8s-ci-robot @tengqm