54896155f7
<!--Delete sections as needed --> ## Description Fixes the generated scout watch docs to use examples from the upstream markdown, instead of the yaml. When previously updated, only the markdown was updated upstream and not the CLI source which generates the yaml. - Added new layout for the scout cli, based on the generic cli layout. The new layout uses the more extensive markdown examples if present, otherwise use the examples from the yaml. - Updated the scout watch topic to use the new layout Once fixed upstream, will have a follow up to most likely revert this. https://deploy-preview-23506--docsdocker.netlify.app/reference/cli/docker/scout/watch/#examples ## Related issues or tickets Original PR to update the version: #23485. The markdown was updated but not the yaml. Upstream fix: https://github.com/docker/scout-cli-plugin/pull/713 ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Editorial review Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
_build
| _build | ||||||
|---|---|---|---|---|---|---|
|
About these files
The files in this directory are stub files which include the file
/_includes/cli.md, which parses YAML files generated from the
docker/cli repository. The YAML files
are parsed into output files like
</reference/cli/docker/build/>.
How the output is generated
The output files are composed from two sources:
-
The Description and Usage sections comes directly from the CLI source code in that repository.
-
The Extended Description and Examples sections are pulled into the YAML from the files in https://github.com/docker/cli/tree/master/docs/reference/commandline for Docker CLI commands and https://github.com/docker/compose/tree/v2/docs/reference for Docker Compose commands. Specifically, the Markdown inside the
## Descriptionand## Examplesheadings are parsed. Submit corrections to the text in those repositories.
Updating the YAML files
The process for generating the YAML files is still in flux. Check with
@thaJeztah. Be sure to generate the YAML files with the correct
release branch of docker/cli, for example, the 19.03 branch.
After generating the YAML files, replace the YAML files in https://github.com/docker/docs/tree/main/_data/engine-cli with the newly-generated files. Submit a pull request.