containerize generating k8s reference documentation script #28037

PI-Victor · 2021-05-18T19:36:44Z

The update-imported-docs.py that is used to generate the kubernetes documentation reference should be containerized to make it easier for users that want to update the ref docs.
This container should include all the tooling mentioned in the quickstart.

Q: OS Linux flavor preferences for the container?
Q: Locally buildable Dockerfile or push an already created image to hub.docker.com/quay.io?
Q: Anything else worth mentioning that i've missed

cc @sftim @reylejano @jimangel @irvifa

/assign
/priority important-soon - targeting this change before 1.22 release

k8s-ci-robot · 2021-05-18T19:36:47Z

@PI-Victor: The label(s) priority/-, priority/targeting, priority/this, priority/change, priority/before, priority/1.22, priority/release cannot be applied, because the repository doesn't have them.

In response to this:

The update-imported-docs.py that is used to generate the kubernetes documentation reference should be containerized to make it easier for users that want to update the docs.
This container should include all the tooling mentioned in the quickstart.

Q: OS preferences for the container?
Q: Locally buildable Dockerfile or push an already created image to hub.docker.com/quay.io?
Q: Anything else worth mentioning that i've missed

cc @sftim @reylejano @jimangel @irvifa

/assign
/priority important-soon - targeting this change before 1.22 release

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/test-infra repository.

sftim · 2021-05-19T07:40:14Z

/triage accepted

sftim · 2021-05-19T07:40:37Z

OS preferences for the container?

Linux 😉

sftim · 2021-05-20T08:51:51Z

/area release-engineering

k8s-ci-robot · 2021-05-20T08:51:52Z

@sftim: The label(s) area/release-engineering cannot be applied, because the repository doesn't have them.

In response to this:

/area release-engineering

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/test-infra repository.

sftim · 2021-05-20T09:06:23Z

/area release-engineering

k8s-ci-robot · 2021-05-20T09:06:24Z

@sftim: The label(s) area/release-engineering cannot be applied, because the repository doesn't have them.

In response to this:

/area release-engineering

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/test-infra repository.

PI-Victor · 2021-05-20T11:19:56Z

/area release-eng

found it!
also, i should've said: linux flavor preferences for the container?

sftim · 2021-05-20T11:22:25Z

linux flavor preferences for the container

No preference from me.

sftim · 2021-08-01T20:52:28Z

As we've missed this for v1.22
/remove-priority important-soon
/priority important-longterm

k8s-triage-robot · 2021-10-30T21:29:04Z

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:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2021-11-29T22:22:37Z

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:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

PI-Victor · 2021-12-01T08:59:52Z

/remove-lifecycle rotten

k8s-triage-robot · 2022-03-01T09:30:34Z

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:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-03-31T09:57:23Z

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:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

sftim · 2022-03-31T11:11:49Z

/lifecycle frozen

k8s-triage-robot · 2023-03-31T12:02:41Z

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

Confirm that this issue is still relevant with /triage accepted (org members only)
Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

Gauravpadam · 2023-11-06T13:48:35Z

Is this issue still relevant? I'd like to help

sftim · 2023-11-07T10:46:41Z

Is this issue still relevant? I'd like to help

Help in this will be very much appreciated @Gauravpadam

sftim · 2023-11-07T10:46:51Z

/triage accepted

Gauravpadam · 2023-11-07T17:10:25Z

@sftim I see some errors on testing the script for release 1.28, Most of them pertaining to release directories not found

While this should not affect our dockerfile, I'd like to know your thoughts on them

- 'make generated_files' is deprecated.  Please use hack/update-codegen.sh instead.
make: *** [Makefile:319: generated_files] Error 1

- cp: cannot stat '/tmp/tmpx1g2t821/src/github.com/kubernetes-sigs/reference-docs/gen-kubectldocs/generators/v1_27/*': No such file or directory

- 2023/11/07 21:43:49 Failed to generate files: failed to read TOC file generators/v1_28/toc.yaml: open generators/v1_28/toc.yaml: no such file or directory

- mkdir -p /home/gp/website/static/docs/reference/generated/kubernetes-api/v1.28/js
  cp gen-apidocs/build/navData.js /home/gp/website/static/docs/reference/generated/kubernetes-api/v1.28/js/
  cp: cannot stat 'gen-apidocs/build/navData.js': No such file or directory
  make: *** [Makefile:91: copyapi] Error 1
  [Error] failed in generating docs for reference-docs

sftim · 2023-11-08T13:25:47Z

I don't have much experience generating this documentation, so I don't really have an opinion here @Gauravpadam.

We should aim to define a container image and a way to run it so that you get the documentation generated.

Gauravpadam · 2023-11-09T07:53:34Z

No worries @sftim, I'll figure it out eventually

Gauravpadam · 2023-12-05T13:40:44Z

Should I just host the image on a public repository?

(I'm mentioning the build steps currently)

PI-Victor added the kind/feature Categorizes issue or PR as related to a new feature. label May 18, 2021

k8s-ci-robot assigned PI-Victor May 18, 2021

k8s-ci-robot added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 18, 2021

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 19, 2021

k8s-ci-robot added the area/release-eng Issues or PRs related to the Release Engineering subproject label May 20, 2021

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 30, 2021

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 29, 2021

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Dec 1, 2021

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 1, 2022

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 31, 2022

k8s-ci-robot added the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Mar 31, 2022

k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Mar 31, 2022

k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. and removed triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Mar 31, 2023

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Nov 7, 2023

Gauravpadam mentioned this issue Nov 21, 2023

Containerized the reference documentation generation script #44029

Closed

Gauravpadam mentioned this issue Dec 23, 2023

Makefile edits for containerization of generation script kubernetes-sigs/reference-docs#345

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

containerize generating k8s reference documentation script #28037

containerize generating k8s reference documentation script #28037

PI-Victor commented May 18, 2021 •

edited

Loading

k8s-ci-robot commented May 18, 2021

sftim commented May 19, 2021

sftim commented May 19, 2021

sftim commented May 20, 2021

k8s-ci-robot commented May 20, 2021

sftim commented May 20, 2021

k8s-ci-robot commented May 20, 2021

PI-Victor commented May 20, 2021

sftim commented May 20, 2021

sftim commented Aug 1, 2021

k8s-triage-robot commented Oct 30, 2021

k8s-triage-robot commented Nov 29, 2021

PI-Victor commented Dec 1, 2021

k8s-triage-robot commented Mar 1, 2022

k8s-triage-robot commented Mar 31, 2022

sftim commented Mar 31, 2022

k8s-triage-robot commented Mar 31, 2023

Gauravpadam commented Nov 6, 2023

sftim commented Nov 7, 2023

sftim commented Nov 7, 2023

Gauravpadam commented Nov 7, 2023 •

edited

Loading

sftim commented Nov 8, 2023

Gauravpadam commented Nov 9, 2023

Gauravpadam commented Dec 5, 2023 •

edited

Loading

containerize generating k8s reference documentation script #28037

containerize generating k8s reference documentation script #28037

Comments

PI-Victor commented May 18, 2021 • edited Loading

k8s-ci-robot commented May 18, 2021

sftim commented May 19, 2021

sftim commented May 19, 2021

sftim commented May 20, 2021

k8s-ci-robot commented May 20, 2021

sftim commented May 20, 2021

k8s-ci-robot commented May 20, 2021

PI-Victor commented May 20, 2021

sftim commented May 20, 2021

sftim commented Aug 1, 2021

k8s-triage-robot commented Oct 30, 2021

k8s-triage-robot commented Nov 29, 2021

PI-Victor commented Dec 1, 2021

k8s-triage-robot commented Mar 1, 2022

k8s-triage-robot commented Mar 31, 2022

sftim commented Mar 31, 2022

k8s-triage-robot commented Mar 31, 2023

Gauravpadam commented Nov 6, 2023

sftim commented Nov 7, 2023

sftim commented Nov 7, 2023

Gauravpadam commented Nov 7, 2023 • edited Loading

sftim commented Nov 8, 2023

Gauravpadam commented Nov 9, 2023

Gauravpadam commented Dec 5, 2023 • edited Loading

PI-Victor commented May 18, 2021 •

edited

Loading

Gauravpadam commented Nov 7, 2023 •

edited

Loading

Gauravpadam commented Dec 5, 2023 •

edited

Loading