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

Kubernetes docs: Replace static tables with the auto-generated tables #25617

Merged
merged 2 commits into from Jun 29, 2022

Conversation

Sgitario
Copy link
Contributor

I found out that some properties were not synced between the content in the Kubernetes guide and the config-all page (which uses the auto generated table).

Let's use the auto-generated tables also in the Kubernetes guide, so we avoid having to maintain these properties, plus also having to explain the inner basic types (as it's already part of the auto generated table).

@Sgitario
Copy link
Contributor Author

cc @geoand @iocanel

@Sgitario
Copy link
Contributor Author

Not sure if we should delete the openshift part taking into account we have a separated guide for OpenShift: https://quarkus.io/guides/deploying-to-openshift

And perhaps we should move the knative part into a new guide too.
Let me know your thoughts about it.

@gsmet
Copy link
Member

gsmet commented Jun 21, 2022

@iocanel could you have a look at this one?

@ebullient ebullient moved this from To do to Docs Team Review in Quarkus Documentation Jun 23, 2022
@ebullient ebullient moved this from Docs Team Review to Review pending in Quarkus Documentation Jun 23, 2022
Copy link
Contributor

@iocanel iocanel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+100 on the idea. However, it's not clear to me who generates those files. I've seen in the past some related jbang scripts which seemed to convert Config object to adoc files. Do I remember correctly?

I found out that some properties were not synced between the content in the Kubernetes guide and the config-all page (which uses the auto generated table).

Let's use the auto-generated tables also in the Kubernetes guide, so we avoid having to maintain these properties, plus also having to explain the inner basic types (as it's already part of the auto generated table).
@Sgitario
Copy link
Contributor Author

+100 on the idea. However, it's not clear to me who generates those files. I've seen in the past some related jbang scripts which seemed to convert Config object to adoc files. Do I remember correctly?

I'm unsure which tool is generating the adoc files from Config objects, but it's working fine so far.
I've just resolved the conflicts.

@iocanel
Copy link
Contributor

iocanel commented Jun 27, 2022

+100 on the idea. However, it's not clear to me who generates those files. I've seen in the past some related jbang scripts which seemed to convert Config object to adoc files. Do I remember correctly?

I'm unsure which tool is generating the adoc files from Config objects, but it's working fine so far. I've just resolved the conflicts.

Ok, I'll take your word for it 😄

Copy link
Contributor

@iocanel iocanel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Quarkus Documentation automation moved this from Review pending to Reviewer approved Jun 27, 2022
@geoand geoand added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jun 27, 2022
@geoand geoand merged commit e4f1236 into quarkusio:main Jun 29, 2022
Quarkus Documentation automation moved this from Reviewer approved to Done Jun 29, 2022
@quarkus-bot quarkus-bot bot added this to the 2.11 - main milestone Jun 29, 2022
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jun 29, 2022
@Sgitario Sgitario deleted the k8s_generated_command branch June 29, 2022 10:28
@gsmet
Copy link
Member

gsmet commented Jun 29, 2022

@Sgitario @iocanel the files are generated during the build by the Quarkus extension plugin (if you don't skip the doc generation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

4 participants