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

Documentation on OutputFormatType references nonexistent file #79236

Merged

Conversation

connor1989
Copy link
Contributor

@connor1989 connor1989 commented Jun 20, 2019

What type of PR is this?
/kind documentation

What this PR does / why we need it:
Reviewing the PrintOptions in the printing package indicates more information can be found in pkg/printers/printers.go. This file was removed around the time of 1.10. The comment is no longer useful.

Fixes #

Does this PR introduce a user-facing change?:
NO

NONE

@k8s-ci-robot
Copy link
Contributor

Welcome @connor1989!

It looks like this is your first PR to kubernetes/kubernetes 🎉. 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/kubernetes 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. 😃

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jun 20, 2019
@k8s-ci-robot
Copy link
Contributor

Hi @connor1989. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 20, 2019
@connor1989
Copy link
Contributor Author

/assign @brendandburns
/sig cli

@k8s-ci-robot k8s-ci-robot added sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jun 20, 2019
@connor1989
Copy link
Contributor Author

@dixudx mentioned source and docs are moved to cli-runtime and present at staging/src/k8s.io/cli-runtime/xxxx. Leaving the change of removal in the case.

Copy link
Member

@dixudx dixudx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

Just removing useless doc here.

/lgtm

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 24, 2019
@dixudx
Copy link
Member

dixudx commented Jun 24, 2019

ping @kubernetes/sig-cli-maintainers for approval.

@connor1989
Copy link
Contributor Author

/test pull-kubernetes-integration

@connor1989
Copy link
Contributor Author

/assign @deads2k

All of the available outputting formats are described within this kubectl Cobra command.

All of the formats are still supported with the only exception being the removal of a shorthand flag. Not sure if it would be more beneficial to update the PR by replacing the referenced file path to the one above or to copy the list into the comment ?

@connor1989
Copy link
Contributor Author

/unassign @brendandburns

@@ -39,7 +39,6 @@ func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error {

// PrintOptions struct defines a struct for various print options
type PrintOptions struct {
// supported Format types can be found in pkg/printers/printers.go
OutputFormatType string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two values are never used. Please delete them both.

@k8s-ci-robot k8s-ci-robot added do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jun 25, 2019
@connor1989 connor1989 force-pushed the doc/remove_invalid_documentation branch from adb4a93 to 265fd04 Compare June 25, 2019 13:11
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. label Jun 25, 2019
@connor1989
Copy link
Contributor Author

@dixudx could you take another pass through on the review for the lgtm

@connor1989
Copy link
Contributor Author

/test pull-kubernetes-e2e-gce
/test pull-kubernetes-kubemark-e2e-gce-big

@connor1989
Copy link
Contributor Author

/retest

@deads2k
Copy link
Contributor

deads2k commented Jun 25, 2019

/ok-to-test
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 25, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: connor1989, deads2k

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:

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 25, 2019
@connor1989
Copy link
Contributor Author

/uncc @ghodss

@k8s-ci-robot k8s-ci-robot removed the request for review from ghodss June 25, 2019 15:55
@fejta-bot
Copy link

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

@k8s-ci-robot k8s-ci-robot merged commit d573a8e into kubernetes:master Jun 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants