python icon indicating copy to clipboard operation
python copied to clipboard

add .readthedocs.yaml config file to fix docs pipeline

Open aapjeisbaas opened this issue 1 year ago • 9 comments

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Fix the broken read the docs build: https://readthedocs.org/projects/kubernetes/builds/

Special notes for your reviewer:

Build works on my branch and output looks the same but witt up to date readme: https://app.readthedocs.org/projects/python-kubernetes-client/builds/25015241/

My other documentation questions:

  1. Why is this not in the published docs: https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md Yes the github interface works but a published version would be nicer to use.

  2. Why are these pages empty: https://python-kubernetes-client.readthedocs.io/en/latest/kubernetes.client.models.v1_container.html

aapjeisbaas avatar Jul 16 '24 08:07 aapjeisbaas

Welcome @aapjeisbaas!

It looks like this is your first PR to kubernetes-client/python 🎉. 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-client/python 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 avatar Jul 16 '24 08:07 k8s-ci-robot

why are many lines commented out?

yliaog avatar Jul 16 '24 15:07 yliaog

I found those lines in the old working build runs and kept them for reference. Maybe you’ve added something special that is now missing. Having the comments with the commands there is just for checking this.

aapjeisbaas avatar Jul 16 '24 17:07 aapjeisbaas

/assign @yliaog

roycaihw avatar Jul 17 '24 20:07 roycaihw

/lgtm /approve

yliaog avatar Jul 21 '24 17:07 yliaog

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

This bot triages 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 PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this 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 avatar Oct 19 '24 18:10 k8s-triage-robot

Pr has status approved why isn’t it being merged? @roycaihw @yliaog

aapjeisbaas avatar Oct 20 '24 00:10 aapjeisbaas

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle rotten

k8s-triage-robot avatar Nov 19 '24 01:11 k8s-triage-robot

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

This bot triages 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 PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

k8s-triage-robot avatar Dec 19 '24 02:12 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

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

This bot triages 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 PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

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 avatar Dec 19 '24 02:12 k8s-ci-robot

Why isn't this merged? Look at the readme difference in the Client version table: This project: https://kubernetes.readthedocs.io/en/latest/README.html My branch from half a year ago: https://python-kubernetes-client.readthedocs.io/en/latest/README.html

The docs page has been stale for ages, please have a look at this.

I just pulled from upstream to update my branch to reflect recent changes, and the build auto started and works great. https://github.com/aapjeisbaas/python-kubernetes-client/tree/fixthedocs

Should I open a new pull request to get this merged?

aapjeisbaas avatar Jan 08 '25 10:01 aapjeisbaas

/reopen

yliaog avatar Jan 15 '25 23:01 yliaog

@yliaog: Reopened this PR.

In response to this:

/reopen

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 avatar Jan 15 '25 23:01 k8s-ci-robot

/release-note-none

yliaog avatar Jan 15 '25 23:01 yliaog

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

This bot triages 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 PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

k8s-triage-robot avatar Feb 15 '25 00:02 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

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

This bot triages 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 PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

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 avatar Feb 15 '25 00:02 k8s-ci-robot

/reopen

roycaihw avatar May 14 '25 16:05 roycaihw

@roycaihw: Reopened this PR.

In response to this:

/reopen

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 avatar May 14 '25 16:05 k8s-ci-robot

/lgtm /approve

roycaihw avatar May 14 '25 16:05 roycaihw

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aapjeisbaas, roycaihw, yliaog

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

The pull request process is described here

Needs approval from an approver in each of these files:
  • ~~OWNERS~~ [roycaihw,yliaog]

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot avatar May 14 '25 16:05 k8s-ci-robot