Skip to content
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

simplify docs generation & serve #113

Closed
wants to merge 3 commits into from

Conversation

M00nF1sh
Copy link

@M00nF1sh M00nF1sh commented Feb 27, 2020

Changes:

  1. remove the docs folder. (it will be hosted in gh-pages branch)
  2. rename docs-source folder to be docs 👀
  3. upgrade mkdocs version & enable strict check
  4. usage:
    • make docs-serve: live-preview docs (renamed serve to be docs-serve 👀 )
    • GITHUB_USER=<> GITHUB_TOKEN=<>make docs-deploy: deploy docs to gh-pages branch

Sample page: https://m00nf1sh.github.io/service-apis/
Sample branch: https://github.com/M00nF1sh/service-apis/tree/gh-pages

TODO:

  • If we can mount a GITHUB_TOKEN to prow, we can deploy docs automatically use post-submit jobs 😃

fix #34

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 27, 2020
@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 27, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: M00nF1sh
To complete the pull request process, please assign bowei
You can assign the PR to them by writing /assign @bowei in a comment when ready.

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

Needs approval from an approver in each of these files:

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

@M00nF1sh M00nF1sh force-pushed the docs_simplify branch 2 times, most recently from 9385f6f to 3e56d39 Compare February 27, 2020 20:24
@M00nF1sh M00nF1sh changed the title simplify docs simplify docs generation & serve Feb 27, 2020
@M00nF1sh M00nF1sh changed the title simplify docs generation & serve [WIP]simplify docs generation & serve Feb 27, 2020
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 27, 2020
@bowei
Copy link
Contributor

bowei commented Feb 27, 2020

thanks -- can you split the commit into two, one for the new build system, and all of the deleted files etc in the other (easier to review)

@M00nF1sh M00nF1sh changed the title [WIP]simplify docs generation & serve simplify docs generation & serve Feb 27, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 27, 2020
@M00nF1sh
Copy link
Author

M00nF1sh commented Feb 27, 2020

@bowei
Thanks :D have split the commits.
BTW, I moved the docker file back, but should we just depends on https://github.com/pypa/pipenv on local system instead of using docker?

@M00nF1sh M00nF1sh force-pushed the docs_simplify branch 6 times, most recently from 5b90376 to 2791f0c Compare February 27, 2020 22:53
@bowei
Copy link
Contributor

bowei commented Feb 27, 2020

My prior experience with having pip update stuff on the local system has been pretty hard to deal with, even with the python virtualization stuff (pyenv), so I would prefer the build to be completely hermetic via docker...after all it's what it was invented for :-)

@M00nF1sh
Copy link
Author

cool :D then the current one should be good, it's based on docker 🤣

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 2, 2020
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 5, 2020
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 18, 2020
@k8s-ci-robot
Copy link
Contributor

@M00nF1sh: PR needs rebase.

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/test-infra repository.

@k8s-ci-robot
Copy link
Contributor

@M00nF1sh: The following test failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
pull-service-apis-verify 2f162f4 link /test pull-service-apis-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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/test-infra repository. I understand the commands that are listed here.

@fejta-bot
Copy link

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

@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 Jul 22, 2020
@robscott
Copy link
Member

Hey @M00nF1sh, thanks for your initial work on this! Sorry we missed following up earlier. It looks like a lot has changed in the past few months so a rebase may end up being relatively complex. Since this PR has gone stale I'm going to close this for now, but still very open to this kind of approach. If you're still interested in this, don't hesitate to reopen the PR.

/close

@k8s-ci-robot
Copy link
Contributor

@robscott: Closed this PR.

In response to this:

Hey @M00nF1sh, thanks for your initial work on this! Sorry we missed following up earlier. It looks like a lot has changed in the past few months so a rebase may end up being relatively complex. Since this PR has gone stale I'm going to close this for now, but still very open to this kind of approach. If you're still interested in this, don't hesitate to reopen the PR.

/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/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use a different branch for generated docs
5 participants