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.

Sign up for GitHub

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

Jump to bottom

[wip] fixup capture statements #21253

Closed
wants to merge 3 commits into from
Closed

[wip] fixup capture statements #21253

wants to merge 3 commits into from

Conversation

kbhawkey
Copy link
Contributor

@kbhawkey kbhawkey commented May 28, 2020 •
edited
Loading

Testing removal of capture statements.
Create shortcodes for common headings.
Ran cleanup script over en only pages to constrain changes.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels May 28, 2020
@k8s-ci-robot
Copy link
Contributor

[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.

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 language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels May 28, 2020
@k8s-ci-robot k8s-ci-robot requested review from aanm and ahg-g May 28, 2020 00:14
@kbhawkey kbhawkey changed the title fixup capture statements [wip] fixup capture statements May 28, 2020
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 28, 2020
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 28, 2020
@kbhawkey
Copy link
Contributor Author

Related to #20977.

@netlify
Copy link

netlify bot commented May 28, 2020

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

Built with commit 0d03535

https://deploy-preview-21253--kubernetes-io-master-staging.netlify.app

@kbhawkey
Copy link
Contributor Author

@zacharysarah , interested to get your feedback on this approach.

@netlify
Copy link

netlify bot commented May 28, 2020 •
edited
Loading

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

Built with commit 909b987

https://deploy-preview-21253--kubernetes-io-master-staging.netlify.app

@sftim
Copy link
Contributor

sftim commented May 28, 2020

Can I help with either implementation or with testing here?

@kbhawkey kbhawkey mentioned this pull request May 28, 2020
Closed
@kbhawkey
Copy link
Contributor Author

Can I help with either implementation or with testing here?

@sftim, I am happy to hear your ideas.
I'd like people to agree on whether,

  • to remove the capture statements and template data in front matter
  • are comments needed in the page body to delineate the page
  • what common headings are needed on the page (for example, prerequisites, whatsnext, ...)

Removing the capture statements should make parsing easier (and faster).
The changes should be compatible with the Docsy theme.

Testing the what's next on this page,
https://deploy-preview-21253--kubernetes-io-master-staging.netlify.app/docs/concepts/architecture/controller/

@kbhawkey kbhawkey mentioned this pull request May 28, 2020
Closed
@kbhawkey
Copy link
Contributor Author

/close

@k8s-ci-robot
Copy link
Contributor

@kbhawkey: Closed this PR.

In response to 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.

@kbhawkey kbhawkey mentioned this pull request Jun 1, 2020
Merged
@kbhawkey kbhawkey deleted the kb-capture-stmts-fixup 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

@aanm aanm Awaiting requested review from aanm

@ahg-g ahg-g Awaiting requested review from ahg-g

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 @sftim