search

kubernetes-sigs / reference-docs

Tools to build reference documentation for Kubernetes APIs and CLIs.
Apache License 2.0
87 stars 102 forks source link

Makefile edits for containerization of generation script #345

Closed Gauravpadam closed 4 months ago

Gauravpadam commented 7 months ago

This PR is associated with https://github.com/kubernetes/website/pull/44029

The aim is to containerize the script which is generating these docs These changes are well tested on my personal fork and they work perfectly fine

k8s-ci-robot commented 7 months ago

Welcome @Gauravpadam!

It looks like this is your first PR to kubernetes-sigs/reference-docs 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/reference-docs has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot commented 7 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Gauravpadam Once this PR has been reviewed and has the lgtm label, please assign sftim for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/kubernetes-sigs/reference-docs/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
kbhawkey commented 7 months ago

Hello @Gauravpadam . I'm not clear that this solves the generation and maintenance of the kubectl reference docs.

Gauravpadam commented 7 months ago

This fixes https://github.com/kubernetes/website/issues/28037, as an extension of https://github.com/kubernetes/website/pull/44029

sftim commented 7 months ago

@Gauravpadam could you write up an explanation of how to:

?

That advice will help people to review the change.

Gauravpadam commented 7 months ago

Sure @sftim, I already have some documented steps open as a PR if that might help; https://github.com/kubernetes/website/pull/44055

I'll also be happy to assist in any way to make the reviewing process simpler

k8s-triage-robot commented 4 months ago

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

You can:

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

/lifecycle stale

Gauravpadam commented 4 months ago

You were a good pr

/close

k8s-ci-robot commented 4 months ago

@Gauravpadam: Closed this PR.

In response to [this](https://github.com/kubernetes-sigs/reference-docs/pull/345#issuecomment-2021131642): >You were a good pr > >/close > > 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.