Add examples to CLI generation templates#1069
Add examples to CLI generation templates#1069mdlinville merged 1 commit intodocker:vnext-enginefrom mdlinville:examples_to_cli_temporary_fix
Conversation
|
Where can I find the code that generates the the yaml for the cli reference? |
|
cc @FrenchBen |
|
@dnephin Code is currently here: Now that your changes have been merged, I can make a PR against docker/docker, but need to possibly add |
johndmulhausen
left a comment
There was a problem hiding this comment.
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
|
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. |
* Delete interlock_service_clusters.png~HEAD * Delete interlock_service_clusters.png~Raw content addition * Clean up interlock files for Amberjack
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