Skip to content

Publish docs #2190

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

Open
cjihrig opened this issue Jan 31, 2025 · 5 comments
Open

Publish docs #2190

cjihrig opened this issue Jan 31, 2025 · 5 comments
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@cjihrig
Copy link
Contributor

cjihrig commented Jan 31, 2025

The build-and-deploy docs job currently fails because of branch protection + the CLA requirement:

remote: error: GH006: Protected branch update failed for refs/heads/gh-pages.        
remote: 
remote: - Required status check "EasyCLA" is expected.        

Can this be fixed by changing the branch protection rules on the gh-pages branch?

I'm open to other options as well.

@mstruebing
Copy link
Member

I'm not sure if we are allowed to remove the easy CLA requirement.
@brendandburns do you know if we can remove it for this one branch?

Another option I could think of would be to use a personal token for that but that's also not a really nice solution either.

@cjihrig
Copy link
Contributor Author

cjihrig commented Jan 31, 2025

I think a worst case solution would be to have a person manually update the docs.

@brendandburns
Copy link
Contributor

We have in the past gotten bot permissions to auto-approve easy-cla.

We should definitely not use personal tokens, but an interim step would be to run this in a personal fork and then send a PR.

Honestly, I don't think that the docs are super useful, so we should also consider just removing them.

@cjihrig
Copy link
Contributor Author

cjihrig commented Feb 10, 2025

Honestly, I don't think that the docs are super useful, so we should also consider just removing them.

I think two things are true. I think the docs are not very good (like most auto-generated docs). I also think the docs are useful for viewing the types and function signatures outside of my IDE.

I tried to create a PR, but GitHub says the git history for the gh-pages branch is too different. I think at a minimum we could force push the branch and then likely leave the docs alone until the next time the code generator is updated.

@k8s-triage-robot
Copy link

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

This bot triages un-triaged issues 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 as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

5 participants