containerize generating k8s reference documentation script

PI-Victor commented 3 years ago

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 commented 3 years ago

@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](https://github.com/kubernetes/website/issues/28037): >The [update-imported-docs.py](https://github.com/kubernetes/website/tree/master/update-imported-docs) 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](https://kubernetes.io/docs/contribute/generate-ref-docs/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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

sftim commented 3 years ago

/triage accepted

sftim commented 3 years ago

OS preferences for the container?

Linux :wink:

sftim commented 3 years ago

/area release-engineering

k8s-ci-robot commented 3 years ago

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

In response to [this](https://github.com/kubernetes/website/issues/28037#issuecomment-844877007): >/area release-engineering Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

sftim commented 3 years ago

/area release-engineering

k8s-ci-robot commented 3 years ago

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

In response to [this](https://github.com/kubernetes/website/issues/28037#issuecomment-844889588): >/area release-engineering Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

PI-Victor commented 3 years ago

/area release-eng

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

sftim commented 3 years ago

linux flavor preferences for the container

No preference from me.

sftim commented 3 years ago

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

k8s-triage-robot commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

/remove-lifecycle rotten

k8s-triage-robot commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

/lifecycle frozen

k8s-triage-robot commented 1 year ago

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 commented 10 months ago

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

sftim commented 10 months ago

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

Help in this will be very much appreciated @Gauravpadam

sftim commented 10 months ago

/triage accepted

Gauravpadam commented 10 months ago

@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 commented 10 months ago

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 commented 10 months ago

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

Gauravpadam commented 9 months ago

Should I just host the image on a public repository?

(I'm mentioning the build steps currently)

kubernetes / website

containerize generating k8s reference documentation script #28037