New resourcesdocs generator#179
Conversation
|
Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA. It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.
DetailsInstructions 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. I understand the commands that are listed here. |
k8s-ci-robot
added
the
cncf-cla: no
k8s-ci-robot
added
the
size/XXL
feloy
force-pushed
the
feloy-gen-resourcesdocs
branch
from
0c35f20 to
6478559
Compare
k8s-ci-robot
added
cncf-cla: yes
sftim
left a comment
sftim
left a comment
There was a problem hiding this comment.
I'm -0 (soft opposed) to including gen-resourcesdocs/api/v1.19/swagger.json and gen-resourcesdocs/api/v1.20/swagger.json; but that's something we could clean up later.
I'm also wary of including the configuration inside gen-resourcesdocs/config/v1.20/ in the same commit as the code that consumes it. These are two related but separate changes.
LGTM, but @feloy if you were willing to split this into multiple commits then I think that works even better.
I'd like someone familiar with Golang to confirm this change is OK to merge.
|
|
||
| kwebsite: clean | ||
| mkdir -p kwebsite/content/en/docs | ||
| go run cmd/main.go kwebsite --config-dir config/v1.20/ --file api/v1.20/swagger.json --output-dir kwebsite/content/en/docs --templates ./templates |
There was a problem hiding this comment.
Would it make sense to take the version as a parameter somehow?
feloy
force-pushed
the
feloy-gen-resourcesdocs
branch
from
6478559 to
f453c46
Compare
It would be nice to make the build reproducible by being sure which swagger file has been used. Do you prefer we put the swagger file on the k/website repo wih the generated files? |
|
It would be really nice if there was a job that created a temporary k8s/k8s repo, grabbed a version of the spec, copied the spec to this repo or website. Temporarily, could add a command to the update-imported-docs script to copy a swagger file or make a new script based off parts of the update script. Drop the swagger file into website. |
|
/approve I'm inclined to kick this in now and start the iteration. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: feloy, tengqm The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
I think it makes sense to get this in. I read through the code, though I have not tried to build the generator. |
|
@sftim, What do you think about getting the source code in now? The swagger files can be removed when the build targets are updated. Is the plan to publish the 1.20 pages generated from the source? |
|
@kbhawkey I agree with your LGTM from #179 (comment) With the caveat that I haven't done code review and haven't much Golang experience. |
k8s-ci-robot
added
the
lgtm
|
@feloy many congratulations 🎉🎉🎉 |
Thanks to everybody 🎆🎆🎆 |
|
Super! |
|
@feloy Congratulations! ✨ 🌟 ✨ |
|
I logged kubernetes/website#25505 to track switching k/website to use the new style API reference. |
6 participants
This generator is used to generate API Reference pages in Markdown format.
See kubernetes/website#23294 for more details