docs: Add reference documentation for plugin #109
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Reference documentation, such as manual pages, complements getting started guides and tutorials by explaining a tool's interface and options in one place.
The
build-container-image
command plugin is the main user-facing tool in the project, so users will benefit from having reference documentation for it, available from the main documentation site.At present,
containertool
will mostly be used through the plugin, which is a thin wrapper which callscontainertool
as a helper. Documentingcontainertool
as a separate tool might be confusing. It has command line help for those who need to use it directly, and as the plugin is largely a wrapper its reference documentation also explains most ofcontainertool
's options.Modifications
containertool
manual page for thebuild-container-image
plugin.Result
Users have access to reference documentation which explains the interface and options of the
build-container-image
command plugin.Test Plan
All existing tests continue to pass.