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.

Sign up for GitHub

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

Jump to bottom

fix: Fix service export example doc #1006

Merged
merged 3 commits into from
Sep 11, 2020
Merged

fix: Fix service export example doc #1006

merged 3 commits into from
Sep 11, 2020

Conversation

dsimansk
Copy link
Contributor

Description

Example of service export doesn't contain actual --mode parameters.

Changes

  • Fix parameters in the service export example

Reference

Fixes #N/A

@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Sep 10, 2020
knative-prow-robot
knative-prow-robot reviewed Sep 10, 2020
View reviewed changes
Copy link
Contributor

@knative-prow-robot knative-prow-robot left a comment

Choose a reason for hiding this comment

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

@dsimansk: 0 warnings.

In response to this:

Description

Example of service export doesn't contain actual --mode parameters.

Changes

  • Fix parameters in the service export example

Reference

Fixes #N/A

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.

@knative-prow-robot knative-prow-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 10, 2020
@knative-prow-robot knative-prow-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 10, 2020
maximilien
maximilien approved these changes Sep 10, 2020
View reviewed changes
Copy link
Contributor

@maximilien maximilien left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Good catch and /lgtm

How cool would it be to have a test that scrapes all commands’ descriptions and try to execute and validate :) them? Turns out @cppforlife and I did that in knctl and I believe he kept that going on the k14s tools. I never got around adding this here but not impossible...

Let me know if interested and we can add and track and execute this as a follow-up issue.

/ok-to-test

@knative-prow-robot knative-prow-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Sep 10, 2020
navidshaikh
navidshaikh reviewed Sep 11, 2020
View reviewed changes
pkg/kn/commands/service/export.go Outdated
Comment on lines 60 to 65
# Export a service in JSON format
kn service export foo -n bar -o json
# Export a service with revisions
kn service export foo --with-revisions --mode=resources -n bar -o json
kn service export foo --with-revisions --mode=export -n bar -o json
# Export services in kubectl friendly format, as a list kind, one service item for each revision
kn service export foo --with-revisions --mode=kubernetes -n bar -o json`,
kn service export foo --with-revisions --mode=replay -n bar -o json`,
Copy link
Collaborator

Choose a reason for hiding this comment

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

should we add a line separator in each example with this to align with other command examples?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, will do.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

PTAL 4aaab55.

navidshaikh
navidshaikh approved these changes Sep 11, 2020
View reviewed changes
Copy link
Collaborator

@navidshaikh navidshaikh left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

thanks!

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 11, 2020
@knative-prow-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dsimansk, maximilien, navidshaikh

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:
  • OWNERS [maximilien,navidshaikh]

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

@knative-prow-robot knative-prow-robot merged commit a1b4f39 into knative:master Sep 11, 2020
@navidshaikh navidshaikh added this to the v0.18.0 milestone Sep 30, 2020
rhuss pushed a commit to rhuss/knative-client that referenced this pull request Oct 5, 2020
@dsimansk @rhuss
fix: Fix service export example doc (knative#1006)
510ebe3 
* fix: Fix service export example doc

* chore: Update changelog

* fix: Add newline divider
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@knative-prow-robot knative-prow-robot knative-prow-robot left review comments

@navidshaikh navidshaikh navidshaikh approved these changes

@maximilien maximilien maximilien approved these changes

@cppforlife cppforlife Awaiting requested review from cppforlife

@evankanderson evankanderson Awaiting requested review from evankanderson

Assignees

@navidshaikh navidshaikh

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v0.18.0
Development

Successfully merging this pull request may close these issues.
5 participants
@dsimansk @knative-prow-robot @maximilien @navidshaikh @googlebot