-
Notifications
You must be signed in to change notification settings - Fork 14.1k
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
Refresh kube-component reference docs #8283
Conversation
Deploy preview for kubernetes-io-master-staging ready! Built with commit d7e2234 https://deploy-preview-8283--kubernetes-io-master-staging.netlify.com |
This PR updates the generated reference docs for kube-components. The source used if from the 'release-1.10' branch of kubernetes/kubernetes.
/assign @tengqm This PR makes sense, except ... it removes the doc for a deprecated flag that isn't yet fully removed from the code/apiserver ( I won't hold up this PR for very long, but I'd like to find someone stateside who can explain the code to me, and maybe we can find some not terrible time that works for both of us to chat, too. I'm guessing these aren't the only flags that aren't showing up properly in the doc, but I'm using them as an indicator of the larger problem. Thanks for your patience! |
@Bradamant3 I understand the concern for not showing the "hidden" flags. Those flags are not shown on the command line when you do, for example, |
@tengqm absolutely agreed that the larger problem needs to be solved upstream. But if you look at the
I'm not in a position to test atm, but this also looks to me as though there's at least meant to be some command-line help to indicate that the flag is deprecated. Which is good UX. So now we (in docs land at least) are in a situation where we can't do the complete right thing if we generate from either I'm overthinking, so assigning a couple of other folks whose judgment I trust to make the final call here. |
@Bradamant3 I don't buy in the idea of "hiding" flags at all. It smells like a lie to users. The components is doing things *undocumented". By "undocumented", I mean there are flags not shown on man pages, not meant to show as help messages, not meant to show as markdown docs, but these flags do exist secretly and they work! This design is somehow breaking the convention how things are deprecated (aka. deprecation policy) across the community. |
@tengqm I agree. This line: Not merging this PR yet bc the Travis build is broken this morning, but getting the process started bc better to document only the current flag (which is currently missing) than only the deprecated flag. Bad choice regardless, but there we are. cc @liggitt |
/lgtm |
I think some form of these should be picked to 1.10.x to ensure we don't hide the flags that are currently usable: |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: zacharysarah 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 |
This PR updates the generated reference docs for kube-components.
The source used if from the 'release-1.10' branch of
kubernetes/kubernetes.
Close: #8280