generate docs

open-component-model · Aug 14, 2024 · f9caf2d · f9caf2d
1 parent 985cd6f
commit f9caf2d
Show file tree

Hide file tree

Showing 109 changed files with 291 additions and 455 deletions.
diff --git a/docs/pluginreference/plugin.md b/docs/pluginreference/plugin.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin <subcommand> <options> <args>
 ```
 
@@ -16,7 +16,6 @@ plugin <subcommand> <options> <args>
 
 ### Description
 
-
 The OCM library has several extension points, which can be used by a registration
 mechanism to add further variants, like repository types, backend technologies,
 access methods, blob downloaders and uploaders.
@@ -52,7 +51,6 @@ Any plugin, regardless of its functionality has to provide an [plugin info](plug
 which prints JSON document containing a plugin descriptor that describes the
 apabilities of the plugin.
 
-
 ### SEE ALSO
 
 

diff --git a/docs/pluginreference/plugin_accessmethod.md b/docs/pluginreference/plugin_accessmethod.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin accessmethod [<options>] <sub command> ...
 ```
 
@@ -13,13 +13,11 @@ plugin accessmethod [<options>] <sub command> ...
 ```
 
 ### Description
-
 This command group provides all commands used to implement an access method
 described by an access method descriptor ([plugin descriptor](plugin_descriptor.md).
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 

diff --git a/docs/pluginreference/plugin_accessmethod_compose.md b/docs/pluginreference/plugin_accessmethod_compose.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin accessmethod compose <name> <options json> <base spec json> [<options>]
 ```
 
@@ -14,7 +14,6 @@ plugin accessmethod compose <name> <options json> <base spec json> [<options>]
 
 ### Description
 
-
 The task of this command is to compose an access specification based on some
 explicitly given input options and preconfigured specifications.
 
@@ -74,10 +73,9 @@ The following predefined value types are supported:
   - <code>string=YAML</code>: string map with arbitrary values defined by dedicated assignments
   - <code>string=string</code>: string map defined by dedicated assignments
   - <code>string=string,string</code>: string map defined by dedicated assignment of comma separated strings
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin accessmethod](plugin_accessmethod.md)	 &mdash; access method operations
 * [plugin](plugin.md)	 &mdash; OCM Plugin

diff --git a/docs/pluginreference/plugin_accessmethod_get.md b/docs/pluginreference/plugin_accessmethod_get.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin accessmethod get [<flags>] <access spec> [<options>]
 ```
 
@@ -16,13 +16,11 @@ plugin accessmethod get [<flags>] <access spec> [<options>]
 
 ### Description
 
-
 Evaluate the given access specification and return the described blob on
 *stdout*.
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin accessmethod](plugin_accessmethod.md)	 &mdash; access method operations
 * [plugin](plugin.md)	 &mdash; OCM Plugin

diff --git a/docs/pluginreference/plugin_accessmethod_validate.md b/docs/pluginreference/plugin_accessmethod_validate.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin accessmethod validate <spec> [<options>]
 ```
 
@@ -14,7 +14,6 @@ plugin accessmethod validate <spec> [<options>]
 
 ### Description
 
-
 This command accepts an access specification as argument. It is used to
 validate the specification and to provide some metadata for the given
 specification.
@@ -41,10 +40,9 @@ following fields:
   The consumer id used to determine optional credentials for the
   underlying repository. If specified, at least the <code>type</code> field must be set.
 
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin accessmethod](plugin_accessmethod.md)	 &mdash; access method operations
 * [plugin](plugin.md)	 &mdash; OCM Plugin

diff --git a/docs/pluginreference/plugin_action.md b/docs/pluginreference/plugin_action.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin action [<options>] <sub command> ...
 ```
 
@@ -13,12 +13,10 @@ plugin action [<options>] <sub command> ...
 ```
 
 ### Description
-
 This command group provides all commands used to implement an action.
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 

diff --git a/docs/pluginreference/plugin_action_execute.md b/docs/pluginreference/plugin_action_execute.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin action execute <spec> [<options>]
 ```
 
@@ -16,7 +16,6 @@ plugin action execute <spec> [<options>]
 
 ### Description
 
-
 This command executes an action.
 
 This action has to provide an execution result as JSON string on *stdout*. It has the
@@ -33,10 +32,9 @@ following fields:
 
 Additional fields depend on the kind of action.
 
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin action](plugin_action.md)	 &mdash; action operations
 * [plugin](plugin.md)	 &mdash; OCM Plugin

diff --git a/docs/pluginreference/plugin_command.md b/docs/pluginreference/plugin_command.md
@@ -1,13 +1,11 @@
 ## plugin command &mdash; CLI Command Extensions
 
 ### Description
-
 This command group provides all CLI command extensions
 described by an access method descriptor ([plugin descriptor](plugin_descriptor.md).
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 

diff --git a/docs/pluginreference/plugin_describe.md b/docs/pluginreference/plugin_describe.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin describe [<options>]
 ```
 
@@ -13,12 +13,10 @@ plugin describe [<options>]
 ```
 
 ### Description
-
 Display a detailed description of the capabilities of this OCM plugin.
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 
diff --git a/docs/pluginreference/plugin_descriptor.md b/docs/pluginreference/plugin_descriptor.md
@@ -2,7 +2,6 @@
 
 ### Description
 
-
 The plugin descriptor describes the capabilities of a plugin. It uses the
 following fields:
 
@@ -294,7 +293,6 @@ The descriptor for a label merge specification has the following fields:
   The configuration settings used for the algorithm. It may contain nested
   merge specifications.
 
-
 ### Examples
 
 ```
@@ -332,7 +330,7 @@ The descriptor for a label merge specification has the following fields:
 
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 

diff --git a/docs/pluginreference/plugin_download.md b/docs/pluginreference/plugin_download.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin download [<flags>] <name> <filepath> [<options>]
 ```
 
@@ -17,7 +17,6 @@ plugin download [<flags>] <name> <filepath> [<options>]
 
 ### Description
 
-
 This command accepts a target filepath as argument. It is used as base name
 to store the downloaded content. The blob content is provided on the
 *stdin*. The first argument specified the downloader to use for the operation.
@@ -26,10 +25,9 @@ The task of this command is to transform the content of the provided
 blob into a filesystem structure applicable to the type specific tools working
 with content of the given artifact type.
 
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 
diff --git a/docs/pluginreference/plugin_info.md b/docs/pluginreference/plugin_info.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin info [<options>]
 ```
 
@@ -14,7 +14,7 @@ plugin info [<options>]
 
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 
diff --git a/docs/pluginreference/plugin_upload.md b/docs/pluginreference/plugin_upload.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin upload [<options>] <sub command> ...
 ```
 
@@ -14,13 +14,11 @@ plugin upload [<options>] <sub command> ...
 
 ### Description
 
-
 This command group provides all commands used to implement an uploader
 described by an uploader descriptor.
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin
 

diff --git a/docs/pluginreference/plugin_upload_put.md b/docs/pluginreference/plugin_upload_put.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin upload put [<flags>] <name> <repository specification> [<options>]
 ```
 
@@ -19,17 +19,15 @@ plugin upload put [<flags>] <name> <repository specification> [<options>]
 
 ### Description
 
-
 Read the blob content from *stdin*, store the blob in the repository specified
 by the given repository specification and return the access specification
 (as JSON document string) usable to retrieve the blob, again, on * stdout*.
 The uploader to use is specified by the first argument. This might only be
 relevant, if the plugin supports multiple uploaders.
 
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin upload](plugin_upload.md)	 &mdash; upload specific operations
 * [plugin](plugin.md)	 &mdash; OCM Plugin

diff --git a/docs/pluginreference/plugin_upload_validate.md b/docs/pluginreference/plugin_upload_validate.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin upload validate [<flags>] <name> <spec> [<options>]
 ```
 
@@ -16,7 +16,6 @@ plugin upload validate [<flags>] <name> <spec> [<options>]
 
 ### Description
 
-
 This command accepts a target specification as argument. It is used to
 validate the specification for the specified upoader and to provide some
 metadata for the given specification.
@@ -30,10 +29,9 @@ following fields:
   underlying repository. If specified, at least the <code>type</code> field must
   be set.
 
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin upload](plugin_upload.md)	 &mdash; upload specific operations
 * [plugin](plugin.md)	 &mdash; OCM Plugin

diff --git a/docs/pluginreference/plugin_valuemergehandler.md b/docs/pluginreference/plugin_valuemergehandler.md
@@ -2,7 +2,7 @@
 
 ### Synopsis
 
-```
+```sh
 plugin valuemergehandler [<options>] <sub command> ...
 ```
 
@@ -13,12 +13,10 @@ plugin valuemergehandler [<options>] <sub command> ...
 ```
 
 ### Description
-
 This command group provides all commands used to implement an value merge handlers.
-
 ### SEE ALSO
 
-##### Parents
+#### Parents
 
 * [plugin](plugin.md)	 &mdash; OCM Plugin