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

document the latest config under the kubeadm-init website page #892

Closed
neolit123 opened this issue Jun 6, 2018 · 1 comment
Closed

document the latest config under the kubeadm-init website page #892

neolit123 opened this issue Jun 6, 2018 · 1 comment
Assignees
Labels
documentation/out-of-date kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone

Comments

@neolit123
Copy link
Member

document the latest config we have here:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/

as discussed on the meeting:
https://docs.google.com/document/d/130_kiXjG7graFNSnIAgtMS1G8zPDwpkshgfRYS0nggo/edit#

kubeadm config: including godocs links vs inlining static configs vs generating configs in the future: #842
[Lubomir] What should we do with configs? link out? generate them? Current idea is to encode current version (v1alpha2) and link to the godoc.
[Tim] We should have a separate page that links out to all the detail of the config object. Mirroring content is bad. If docs link to godoc, then it forces devs to make sure the docs are up to date.
[Jennifer] We should branch for now. But relying on godocs is completely different than how the rest of the docs website works. Could bring it up to sig-docs. Make a proposal and present to sig-docs if we want to change how we reference code.
[Action Item] Generate data into docs and figure out a long term solution later.
[Tim] There has to be a deprecation policy on the old config

summary:
we can't do more for 1.11 other than including the latest output from kubeadm config print-default, mentioning the command and linking to godocs where we have comments for the fields.

@timothysc @Bradamant3

@neolit123 neolit123 added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. documentation/out-of-date kind/documentation Categorizes issue or PR as related to documentation. labels Jun 6, 2018
@neolit123 neolit123 added this to the v1.11 milestone Jun 6, 2018
@neolit123 neolit123 self-assigned this Jun 6, 2018
@neolit123 neolit123 changed the title document the latest config at website under the kubeadm-init website page document the latest config under the kubeadm-init website page Jun 6, 2018
@neolit123
Copy link
Member Author

this was merged:
kubernetes/website#8958

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation/out-of-date kind/documentation Categorizes issue or PR as related to documentation. 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

1 participant