Update commandline yaml docs by seemethere · Pull Request #7753 · docker/docs

seemethere · 2018-11-26T20:23:03Z

Proposed changes

Updates the commandline yaml docs to the latest HEAD of
https://github.com/docker/cli/releases/tag/v18.09.0

Steps to do:

Checkout revision on docker/cli

git -C ~/go/src/github.com/docker/cli fetch --all && git -C ~/go/src/github.com/docker/cli checkout v18.09.0

Generate yamldocs

make -C ~/go/src/github.com/docker/cli -f docker.Makefile yamldocs

Copy yamldocs over to the _data/engine-cli directory

cp ~/go/src/github.com/docker/cli/docs/yaml/gen/*.yaml _data/engine-cli/

This could be automated to be done on any release, or else we could make this a separate thing that can be updated automatically out of band from docker.github.io

@ahh-docker We should also probably cut a branch for 18.09 and do this process for that as well.

Unreleased project version (optional)

Related issues (optional)

Relates to #7358

GordonTheTurtle · 2018-11-26T20:34:11Z

Deploy preview for docsdocker ready!

Built with commit c5c166a

https://deploy-preview-7753--docsdocker.netlify.com

ahh-docker · 2018-11-27T16:33:43Z

@seemethere The other thing we need to look at, is do we need to create a fork of the docker/cli repo? If so, we need to write down those instructions too. What do we need to do if we need to fix broken links?

what do we do to make sure this is merged into docs.docker.com?

ahh-docker · 2018-11-27T16:34:28Z

@seemethere Also, how we do generate this for a specific release? the instructions aren't here on how to do that.

seemethere · 2018-11-27T17:58:13Z

@ahh-docker No fork would need to be created, for different releases you would just checkout the tag (i.e. instead of git checkout master you'd do a git checkout <TAG>)

For a specific release this could be an automated pull request that gets triggered upon a successful release. Currently the release team doesn't have the bandwidth to be able to do that but we can put it on our issue tracker to get done most likely in Q1.

thaJeztah · 2018-11-28T21:45:32Z

git -C ~/go/src/github.com/docker/cli fetch --all && git -C ~/go/src/github.com/docker/cli checkout master

I think this should be using the 18.09 branch, otherwise there's a chance we fetch documentation for the next (19.03) release, and pull in changes that are not yet released

seemethere · 2018-11-28T22:10:37Z

Updated to only reflect changes in the v18.09.0 tag

thaJeztah · 2018-11-29T14:26:29Z

_data/engine-cli/docker_container_exec.yaml

 short: Run a command in a running container
 long: Run a command in a running container
-usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...]
+usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...] [flags]


Hm.. interesting that it's adding the [flags] here. That was fixed on the CLI usage output in docker/cli#1069, but looks like a change may be needed for the code that generates the YAML 🤔

Opened a PR with a fix; docker/cli#1539

So @thaJeztah would you say these yaml docs are good to merge without the fix for now? Would like to get a resolution on this ASAP.

Let me try getting them merged; if you can then regenerate from the 18.09 release branch (instead of the tag), then it should be fixed. DM'ing some people on Slack now 😅

@seemethere docker/cli#1540 was merged, so if you can update using the 18.09 release branch, we should be good to go 🤗

ahh-docker

LGTM. We need to move the instructions somewhere other than the PR. I'm going to copy them to docs-private/wiki.

thaJeztah

can you update from the 18.09 branch, now that the fix was merged? #7753 (comment)

ahh-docker · 2018-11-30T02:15:02Z

@seemethere I tried to do this myself, and ran into some issues:

Fetching origin
Note: checking out 'v18.09.0'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:

  git checkout -b <new-branch-name>

HEAD is now at 51668a30 Merge pull request #1483 from thaJeztah/18.09_backport_docs_fixes

$home/repos- make -C cli fetch -f docker.Makefile yamldocs
make: *** No rule to make target `fetch'.  Stop.

seemethere · 2018-11-30T02:22:33Z

@ahh-docker Have updated the original OP with instructions without error. There was a leftover fetch argument from my copy/paste

Updates the commandline yaml docs to the latest HEAD of `docker/cli@2d692aedb` Signed-off-by: Eli Uriegas <eli.uriegas@docker.com>

seemethere · 2018-11-30T02:23:33Z

@thaJeztah have updated my PR to account for docs without the [flag],

Diff is here: https://github.com/docker/docker.github.io/compare/35fffce9eca42b88ee206937a5ebc6d798c52f3d..c5c166a74f730c9c7de2d4e1e7687b92568d304e

thaJeztah

LGTM, thanks!

ahh-docker · 2018-11-30T18:50:40Z

@seemethere ready to merge? If so, I'll go ahead and merge it. LGTM.

ahh-docker self-requested a review November 26, 2018 20:29

ahh-docker self-assigned this Nov 26, 2018

This was referenced Nov 26, 2018

docs.docker.com/engine/reference/commandline/cli/ missing engine commands #7755

Closed

Document SSH usage for Docker builder #7731

Merged

seemethere force-pushed the update_yaml branch from 6a8ab2c to 35fffce Compare November 28, 2018 22:10

thaJeztah reviewed Nov 29, 2018

View reviewed changes

ahh-docker approved these changes Nov 30, 2018

View reviewed changes

thaJeztah requested changes Nov 30, 2018

View reviewed changes

Update commandline yaml docs

c5c166a

Updates the commandline yaml docs to the latest HEAD of `docker/cli@2d692aedb` Signed-off-by: Eli Uriegas <eli.uriegas@docker.com>

seemethere force-pushed the update_yaml branch from 35fffce to c5c166a Compare November 30, 2018 02:22

thaJeztah approved these changes Nov 30, 2018

View reviewed changes

ahh-docker merged commit 7ea2fd5 into docker:master Nov 30, 2018

bermudezmt mentioned this pull request Dec 6, 2018

update dockerd commandline reference with latest doc changes from docker/cli #7358

Closed

thaJeztah mentioned this pull request Jan 9, 2019

Engine CLI 404 docker/cli#1607

Closed

Conversation

seemethere commented Nov 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Unreleased project version (optional)

Related issues (optional)

Uh oh!

GordonTheTurtle commented Nov 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ahh-docker commented Nov 27, 2018

Uh oh!

ahh-docker commented Nov 27, 2018

Uh oh!

seemethere commented Nov 27, 2018

Uh oh!

thaJeztah commented Nov 28, 2018

Uh oh!

seemethere commented Nov 28, 2018

Uh oh!

thaJeztah Nov 29, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Nov 29, 2018

Choose a reason for hiding this comment

Uh oh!

seemethere Nov 29, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Nov 29, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Nov 29, 2018

Choose a reason for hiding this comment

Uh oh!

ahh-docker left a comment

Choose a reason for hiding this comment

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

ahh-docker commented Nov 30, 2018

Uh oh!

seemethere commented Nov 30, 2018

Uh oh!

seemethere commented Nov 30, 2018

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

ahh-docker commented Nov 30, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

seemethere commented Nov 26, 2018 •

edited

Loading

GordonTheTurtle commented Nov 26, 2018 •

edited

Loading