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

Generate docs for the e2e tests #84872

Closed
johnSchnake opened this issue Nov 6, 2019 · 7 comments
Closed

Generate docs for the e2e tests #84872

johnSchnake opened this issue Nov 6, 2019 · 7 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/testing Categorizes an issue or PR as relevant to SIG Testing.

Comments

@johnSchnake
Copy link
Contributor

What would you like to be added:
Publishing of the docs related to the e2e.test binary as part of the release cycle.

Why is this needed:
There are lots of flags defined to customize test behavior but in order to view them you have to access the e2e binary directly which most people dont do (using Sonobuoy or some other tool to run the tests elsewhere; only interacting with the test image).

In addition, historically the flags weren't even usable via the conformance test image since it didn't recognize any other flags. But with v1.16+ there is a method to add arbitrary flags to the test invocation so more and more users are asking about tweaking various behaviors.

At this time, when asked, I have to point them to the code where the flags are defined but this is not the best experience.

** Proposed approach **:
Following the steps here: https://github.com/spf13/cobra#generating-documentation-for-your-command we add a new flag to the e2e.test binary --generate-docs which, if specified, will generate markdown/man pages (one? both?) and output them. Then this output is captured and published (where?).

The implementation is very straight forward but I am unsure about the release process and where the best place to put these docs would be: k/k? k/community? k/sig-release? cncf/conformance alongside the list of conformance tests?

@johnSchnake johnSchnake added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 6, 2019
@k8s-ci-robot k8s-ci-robot added the needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Nov 6, 2019
@johnSchnake
Copy link
Contributor Author

/sig testing
/kind documentation
/area developer-guide

@k8s-ci-robot k8s-ci-robot added sig/testing Categorizes an issue or PR as relevant to SIG Testing. kind/documentation Categorizes issue or PR as related to documentation. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Nov 6, 2019
@k8s-ci-robot
Copy link
Contributor

@johnSchnake: The label(s) area/developer-guide cannot be applied. These labels are supported: api-review, community/discussion, community/maintenance, community/question, cuj/build-train-deploy, cuj/multi-user, platform/aws, platform/azure, platform/gcp, platform/minikube, platform/other

In response to this:

/sig testing
/kind documentation
/area developer-guide

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.

@ttfreeman
Copy link

@johnSchnake I would be happy to work on this as my first issue. Please feel free to assign and I'll get started. Thanks.

@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 Feb 25, 2020
@fejta-bot
Copy link

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

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 26, 2020
@fejta-bot
Copy link

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
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

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

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
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/testing Categorizes an issue or PR as relevant to SIG Testing.
Projects
None yet
Development

No branches or pull requests

4 participants