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

Add machine output documentation #2678

Merged

Conversation

@cdrage
Copy link
Collaborator

cdrage commented Mar 4, 2020

What type of PR is this?

/kind documentation

What does does this PR do / why we need it:

Adds a table and references to machine output documentation

Which issue(s) this PR fixes:

N/A

How to test changes / Special notes to the reviewer:

View the doc

Signed-off-by: Charlie Drage charlie@charliedrage.com

@cdrage cdrage force-pushed the cdrage:machine-output-documentation branch from 4705a43 to a06ad9a Mar 4, 2020
@openshift-ci-robot openshift-ci-robot added size/L and removed size/XL labels Mar 4, 2020
@cdrage

This comment has been minimized.

Copy link
Collaborator Author

cdrage commented Mar 4, 2020

Quick update to machine readable output docs.

Does this look okay / decent @Preeticp @boczkowska ?

Since it's only developer docs, I'm assuming it wont need too much of a review since it wouldn't be on the OpenShift site.

@amitkrout

This comment has been minimized.

Copy link
Collaborator

amitkrout commented Mar 5, 2020

/test v4.2-integration-e2e-benchmark

Copy link
Collaborator

amitkrout left a comment

@cdrage I can see few subcommand looks like a hyperlink. Is it intensional ?

Screen Shot 2020-03-05 at 12 53 41 PM

| N

|
| <<catalog-list-components,list components>>

This comment has been minimized.

Copy link
@Preeticp

Preeticp Mar 5, 2020

Collaborator

This link and the ones on lines 35, 39, 111, 115, 131, 139 do not work. Most probably cause they are not listed below, are we planning to add those sections here? Is that why we have these links?

This comment has been minimized.

Copy link
@cdrage

cdrage Mar 5, 2020

Author Collaborator

Yes, that's intentional, just wanted to see if this format is fine 👍


== component describe

This comment has been minimized.

Copy link
@Preeticp

Preeticp Mar 5, 2020

Collaborator

Component describe and Component list are described twice.

`odo app describe -o json | jq`

```json
See the below table for a list of all possible machine readable output commands:

This comment has been minimized.

Copy link
@Preeticp

Preeticp Mar 5, 2020

Collaborator

@cdrage, iiuc, only those which have machine readable output implemented have the links? Do you think it makes sense to have the links to all of those which have sections outlined below?

This comment has been minimized.

Copy link
@cdrage

cdrage Mar 5, 2020

Author Collaborator

Yup. Only the ones implemented have the links.

@cdrage cdrage force-pushed the cdrage:machine-output-documentation branch from a06ad9a to 94193b3 Mar 6, 2020
@codecov

This comment has been minimized.

Copy link

codecov bot commented Mar 6, 2020

Codecov Report

Merging #2678 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2678      +/-   ##
==========================================
+ Coverage   43.87%   43.89%   +0.02%     
==========================================
  Files          82       82              
  Lines        7581     7581              
==========================================
+ Hits         3326     3328       +2     
+ Misses       3931     3930       -1     
+ Partials      324      323       -1
Impacted Files Coverage Δ
pkg/component/watch.go 74% <0%> (+1.33%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9b3c652...812233f. Read the comment docs.

@cdrage cdrage force-pushed the cdrage:machine-output-documentation branch from 94193b3 to 52f227a Mar 10, 2020
**What type of PR is this?**

> /kind documentation

**What does does this PR do / why we need it**:

Adds a table and references to machine output documentation

**Which issue(s) this PR fixes**:

N/A

**How to test changes / Special notes to the reviewer**:

View the doc

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
@cdrage cdrage force-pushed the cdrage:machine-output-documentation branch from 52f227a to 812233f Mar 10, 2020
@kadel

This comment has been minimized.

Copy link
Member

kadel commented Mar 10, 2020

/approve

@openshift-ci-robot

This comment has been minimized.

Copy link

openshift-ci-robot commented Mar 10, 2020

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kadel

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

@cdrage cdrage added the lgtm label Mar 13, 2020
@openshift-merge-robot openshift-merge-robot merged commit b9bdb6b into openshift:master Mar 13, 2020
6 checks passed
6 checks passed
Travis CI - Pull Request Build Passed
Details
ci/prow/unit Job succeeded.
Details
ci/prow/v4.1-integration-e2e-benchmark Job succeeded.
Details
ci/prow/v4.2-integration-e2e-benchmark Job succeeded.
Details
ci/prow/v4.3-integration-e2e-benchmark Job succeeded.
Details
tide In merge pool.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
You can’t perform that action at this time.