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 examples to CLI generation templates #1069

Merged
merged 1 commit into from
Jan 13, 2017
Merged

Add examples to CLI generation templates #1069

merged 1 commit into from
Jan 13, 2017

Conversation

mdlinville
Copy link

Proposed changes

Add the examples for the CLI commands into the CLI-generation templates until they can be included as part of the YAML. Workaround as discussed with @johndmulhausen until the examples can be shipped to us in the YAML. cc/ @FrenchBen @dnephin

Unreleased project version (optional)

Engine 1.13

@dnephin
Copy link
Contributor

dnephin commented Jan 10, 2017

Where can I find the code that generates the the yaml for the cli reference?

@mdlinville
Copy link
Author

cc @FrenchBen

@FrenchBen
Copy link
Contributor

@dnephin Code is currently here:
https://github.com/FrenchBen/docker/blob/generate-cli-reference/docs/gen/generate.go#L48

Now that your changes have been merged, I can make a PR against docker/docker, but need to possibly add dockerd CLI beforehand.

Copy link

@johndmulhausen johndmulhausen left a comment

Choose a reason for hiding this comment

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

Looks like some unescaped Liquid-esque text is tripping up the build here:

2:23:05 PM: Liquid Warning: Liquid syntax error (line 185): [:dot, "."] is not a valid expression in "{{.IPAddress}}" in engine/reference/commandline/inspect.md
Liquid Warning: Liquid syntax error (line 193): Unexpected character $ in "{{range $p, $conf := .NetworkSettings.Ports}}" in engine/reference/commandline/inspect.md
Liquid Warning: Liquid syntax error (line 194): Unexpected character $ in "{{$p}}" in engine/reference/commandline/inspect.md
Liquid Warning: Liquid syntax error (line 194): Unexpected character $ in "{{(index $conf 0).HostPort}}" in engine/reference/commandline/inspect.md
2:23:41 PM: Conversion error: Jekyll::Converters::Markdown encountered an error while converting 'engine/reference/commandline/service_create.md':
2:23:41 PM: undefined method `split' for nil:NilClass
2:23:41 PM: jekyll 3.3.1 | Error: undefined method `split' for nil:NilClass

@mdlinville
Copy link
Author

Fixed all the problems and the netlify preview looks great. See https://deploy-preview-1069--docker-docs-vnext-engine.netlify.com/engine/reference/commandline/run/. I'll merge this for now and we can revert it later when the examples are part of the YAML.

@mdlinville mdlinville merged commit 3fc38dc into docker:vnext-engine Jan 13, 2017
@mdlinville mdlinville deleted the examples_to_cli_temporary_fix branch January 13, 2017 18:46
bermudezmt added a commit that referenced this pull request May 22, 2019
* Delete interlock_service_clusters.png~HEAD

* Delete interlock_service_clusters.png~Raw content addition

* Clean up interlock files for Amberjack
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants