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

Render API reference using a content adapter #46424

Open
sftim opened this issue May 17, 2024 · 2 comments
Open

Render API reference using a content adapter #46424

sftim opened this issue May 17, 2024 · 2 comments
Labels
area/dependency Issues or PRs related to dependency changes area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@sftim
Copy link
Contributor

sftim commented May 17, 2024

This is a Feature Request

What would you like to be added
[If we like the idea], use a Hugo content adapter to render our API reference pages. This may need supporting code to generate the input data.

Why is this needed
Likely benefits:

  • This approach cuts the effort to localize the API reference pages, compared to the existing more manual approach.
  • Content adapters let us control the layout (as in URL paths) of the generated pages, and to define the rules in code.
  • By moving more of the generation into the Hugo site build, we can automatically hyperlink reference pages to related content pages (such as tutorials and concept guides).

Comments
/area web-development

We'd also need to use Hugo v0.126 or later.

@sftim sftim added the kind/feature Categorizes issue or PR as related to a new feature. label May 17, 2024
@k8s-ci-robot k8s-ci-robot added the area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes label May 17, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 17, 2024
@Aaina26
Copy link
Contributor

Aaina26 commented May 19, 2024

Since this feature request will also change dependency. I would like to add one more tag.
/area dependency

@k8s-ci-robot k8s-ci-robot added the area/dependency Issues or PRs related to dependency changes label May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dependency Issues or PRs related to dependency changes area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

3 participants