Open Jefftree opened 2 years ago
/remove-kind bug
/kind feature
We see reference doc generation as best-effort. There's definitely room for improvement.
/triage accepted
Duplicated by https://github.com/kubernetes/website/issues/36947
The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.
This bot triages issues and PRs according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, lifecycle/rotten
is appliedlifecycle/rotten
was applied, the issue is closedYou can:
/remove-lifecycle stale
/lifecycle rotten
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.
This bot triages issues and PRs according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, lifecycle/rotten
is appliedlifecycle/rotten
was applied, the issue is closedYou can:
/remove-lifecycle rotten
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten
/remove-lifecycle rotten
This issue has not been updated in over 1 year, and should be re-triaged.
You can:
/triage accepted
(org members only)/close
For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/
/remove-triage accepted
The Kubernetes project currently lacks enough contributors to adequately respond to all issues.
This bot triages un-triaged issues according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, lifecycle/rotten
is appliedlifecycle/rotten
was applied, the issue is closedYou can:
/remove-lifecycle stale
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.
This bot triages un-triaged issues according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, lifecycle/rotten
is appliedlifecycle/rotten
was applied, the issue is closedYou can:
/remove-lifecycle rotten
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten
/remove-lifecycle rotten
How I'd like this fixed:
description
is always Markdowndescription
is always Markdowndescription
OpenAPI field~
I learned that OpenAPI description
is always MarkdownWe should either:
Optionally, also:
/triage accepted
/remove-kind feature /kind bug
Duplicated by https://github.com/kubernetes/website/issues/47070
I have a couple of ideas for a potential fix for this issue if no one has picked it up yet. /assign
Help is (still) welcome. It may be that most of the work is around getting the OpenAPI to contain the right Markdown, and then the docs generation becomes relatively easy.
This is a Bug Report
Problem: Code blocks not rendered properly in documentation
See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#quantity-resource-core
The Quantity description has a code block embedded in the code https://github.com/kubernetes/kubernetes/blob/3ffdfbe286ebcea5d75617da6accaf67f815e0cf/api/openapi-spec/v3/apis__node.k8s.io__v1_openapi.json#L177
(This is the same as what is provided in the swagger.json. The swagger.json file wasn't able to be linked because it's too large for Github's code search)
This is not being rendered properly and is just dumped on one line in the documentation
Proposed Solution: I haven't really looked into the code, is this something that can be fixed in the Markdown rendering?
Page to Update: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#quantity-resource-core
^ Docs for future k8s versions