update-imported-docs in golang#6642
update-imported-docs in golang#6642steveperry-53 merged 1 commit intokubernetes:masterfrom mengqiy:play
Conversation
|
Deploy preview ready! Built with commit c22066e https://deploy-preview-6642--kubernetes-io-master-staging.netlify.com |
|
/assign @apelisse |
|
@mengqiy The master branch is fine for this PR. |
|
@steveperry-53 Are you going to use this script to update the imported docs for 1.9 release? Or if you want to keep the PRs that are manually crafted i.e. #6614 #6619 #6628? |
|
SG. I guess you only need to run it once after you populate the config.yaml. IOW, I guess you will only need 1 PR. One concern: if this PR is merged into master branch, will you guys do fast-forward (or something else) to make 1.9 branch have this program as well? #6614, #6619, and #6628 can be used as reference to check if everything looks correct. |
|
@mengqiy At this point, we should wait until after the 1.9 release to merge this PR. On Wednesday, 12/13, the plan is to merge kubernetes/website:release-1.9 into kubernetes/website:master. After that, we can merge this PR into master. In the meantime, I have cloned mengqiy/website:play, and am running the script to generate docs. I'll submit those generated docs in a PR to kubernetes/website:release-1.9. I should be able to do that tonight. |
|
See #6658. Notice that in some topics, the synopsis appears twice. Example: kubectl options. For the 1.9 release, I'll just fix these manually. |
|
Thanks for you feedback. |
|
|
Thanks! I will dig it tomorrow or next Monday. |
Do you mean it appears once in
The link you gave actually links to After digging this a bit, I found it's not the problem of this script. The generated doc looks the same. So if the format is wrong, then the issue is in the |
|
Reviewed 3 of 3 files at r1. Comments from Reviewable |
|
@mengqiy Thanks for checking into this. My mistake on the link text; I meant it to say kubefed options. Are you ready for me to merge this PR now? These are the files that had the double synopsis:
The synopsis appeared once just below the title and once just below the Synopsis heading. This commit When I get a chance, I'll take a look at the federation scripts, and see about getting those fixed. Before I did the removal, the pages looked like this: kubefed init Initialize a federation control plane Synopsis Init initializes a federation control plane. |
The wording are not the same, so I think they not duplicate but they are generated from different origins with similar meaning. |
|
@mengqiy Should I go ahead and merge this PR? |
|
Please go ahead and merge it. :) |
update-imported-docs/config.yamlshould have the src and dest paths for the target files.fixes: #4283
/assign @steveperry-53
I'm not sure what branch (master or release-1.9) should this PR target.
This change is