kubernetes-client / python

Official Python client library for kubernetes
http://kubernetes.io/
Apache License 2.0
6.79k stars 3.27k forks source link

en... #1207

Closed biwenKey closed 3 years ago

biwenKey commented 4 years ago

Link to the issue (please include a link to the specific documentation or example):

Description of the issue (please include outputs or screenshots if possible): image

roycaihw commented 4 years ago

The core v1 API group is huge for legacy reason. The doc is generated from the upstream openapi spec by the openapi-generator. I think the issue applies to all the generated clients (e.g. the java client) as well. You could download the raw file and view it with a different render that supports larger files than Github

fejta-bot commented 4 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

aalexanderr commented 4 years ago

Until the issue is fixed, this might help some people. Written for complete newbies so no one should have problems with it (if you use *nix)

Required tools:

  1. Bash
  2. Pandoc for rendering markdown files to html.
  3. A template for pandoc, the default one produces huge margins which make table-based documentation super hard to read. I used mindoc
mkdir -p html
for source in *.md; do
    [ -f "$source" ] || break
    output=${source/.md/.html}
    pandoc -s \
           -t html \
           -o html/$output \
           -f gfm \
           --template mindoc-pandoc.html \
           --metadata title=`basename $source` \
           $source
    sed -i 's/.md/.html/g' html/$output
done

Usage:

  1. Start in repository root
  2. cd kubernetes/docs
  3. wget https://raw.githubusercontent.com/bitfragment/mindoc/master/dist/mindoc-pandoc.html or curl https://raw.githubusercontent.com/bitfragment/mindoc/master/dist/mindoc-pandoc.html
  4. copy-paste the script above to your shell and press enter
  5. when it finishes you should have html directory with docs that have working links (except for README.md as I didnt care about it, feel free to adjust it to include it)
  6. open a doc and navigate using working urls xdg-open html/CoreV1Api.html
fejta-bot commented 3 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle rotten

fejta-bot commented 3 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /close

k8s-ci-robot commented 3 years ago

@fejta-bot: Closing this issue.

In response to [this](https://github.com/kubernetes-client/python/issues/1207#issuecomment-754077280): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >Send feedback to sig-testing, kubernetes/test-infra and/or [fejta](https://github.com/fejta). >/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.