diff --git a/docs/pluginreference/plugin.md b/docs/pluginreference/plugin.md index dfccfdc733..a1c4dabfdc 100644 --- a/docs/pluginreference/plugin.md +++ b/docs/pluginreference/plugin.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin ``` @@ -16,7 +16,6 @@ plugin ### 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 index 9449f0ba8e..ceebe2eddd 100644 --- a/docs/pluginreference/plugin_accessmethod.md +++ b/docs/pluginreference/plugin_accessmethod.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin accessmethod [] ... ``` @@ -13,13 +13,11 @@ plugin accessmethod [] ... ``` ### 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) — OCM Plugin diff --git a/docs/pluginreference/plugin_accessmethod_compose.md b/docs/pluginreference/plugin_accessmethod_compose.md index e451f8f7c7..b4c908b9a6 100644 --- a/docs/pluginreference/plugin_accessmethod_compose.md +++ b/docs/pluginreference/plugin_accessmethod_compose.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin accessmethod compose [] ``` @@ -14,7 +14,6 @@ plugin accessmethod compose [] ### 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: - string=YAML: string map with arbitrary values defined by dedicated assignments - string=string: string map defined by dedicated assignments - string=string,string: string map defined by dedicated assignment of comma separated strings - ### SEE ALSO -##### Parents +#### Parents * [plugin accessmethod](plugin_accessmethod.md) — access method operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_accessmethod_get.md b/docs/pluginreference/plugin_accessmethod_get.md index 6c2018cc70..046ac342a0 100644 --- a/docs/pluginreference/plugin_accessmethod_get.md +++ b/docs/pluginreference/plugin_accessmethod_get.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin accessmethod get [] [] ``` @@ -16,13 +16,11 @@ plugin accessmethod get [] [] ### Description - Evaluate the given access specification and return the described blob on *stdout*. - ### SEE ALSO -##### Parents +#### Parents * [plugin accessmethod](plugin_accessmethod.md) — access method operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_accessmethod_validate.md b/docs/pluginreference/plugin_accessmethod_validate.md index 1bb553c1c2..b3ce5ec93a 100644 --- a/docs/pluginreference/plugin_accessmethod_validate.md +++ b/docs/pluginreference/plugin_accessmethod_validate.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin accessmethod validate [] ``` @@ -14,7 +14,6 @@ plugin accessmethod validate [] ### 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 type field must be set. - ### SEE ALSO -##### Parents +#### Parents * [plugin accessmethod](plugin_accessmethod.md) — access method operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_action.md b/docs/pluginreference/plugin_action.md index 234ab75da5..eee30fe18d 100644 --- a/docs/pluginreference/plugin_action.md +++ b/docs/pluginreference/plugin_action.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin action [] ... ``` @@ -13,12 +13,10 @@ plugin action [] ... ``` ### Description - This command group provides all commands used to implement an action. - ### SEE ALSO -##### Parents +#### Parents * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_action_execute.md b/docs/pluginreference/plugin_action_execute.md index 534255a9f1..513ee489d3 100644 --- a/docs/pluginreference/plugin_action_execute.md +++ b/docs/pluginreference/plugin_action_execute.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin action execute [] ``` @@ -16,7 +16,6 @@ plugin action execute [] ### 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) — action operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_command.md b/docs/pluginreference/plugin_command.md index 57d91820db..72c06b96f4 100644 --- a/docs/pluginreference/plugin_command.md +++ b/docs/pluginreference/plugin_command.md @@ -1,13 +1,11 @@ ## plugin command — 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) — OCM Plugin diff --git a/docs/pluginreference/plugin_describe.md b/docs/pluginreference/plugin_describe.md index 82e65ddb47..ed5ef99a43 100644 --- a/docs/pluginreference/plugin_describe.md +++ b/docs/pluginreference/plugin_describe.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin describe [] ``` @@ -13,12 +13,10 @@ plugin describe [] ``` ### Description - Display a detailed description of the capabilities of this OCM plugin. - ### SEE ALSO -##### Parents +#### Parents * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_descriptor.md b/docs/pluginreference/plugin_descriptor.md index e2c05f2bae..ca18616cf1 100644 --- 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) — OCM Plugin diff --git a/docs/pluginreference/plugin_download.md b/docs/pluginreference/plugin_download.md index 35f54e0e9e..e30d975836 100644 --- a/docs/pluginreference/plugin_download.md +++ b/docs/pluginreference/plugin_download.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin download [] [] ``` @@ -17,7 +17,6 @@ plugin download [] [] ### 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) — OCM Plugin diff --git a/docs/pluginreference/plugin_info.md b/docs/pluginreference/plugin_info.md index 988f3a6aea..f2750d7a38 100644 --- a/docs/pluginreference/plugin_info.md +++ b/docs/pluginreference/plugin_info.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin info [] ``` @@ -14,7 +14,7 @@ plugin info [] ### SEE ALSO -##### Parents +#### Parents * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_upload.md b/docs/pluginreference/plugin_upload.md index 8234e41c1d..0ee23a42b2 100644 --- a/docs/pluginreference/plugin_upload.md +++ b/docs/pluginreference/plugin_upload.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin upload [] ... ``` @@ -14,13 +14,11 @@ plugin upload [] ... ### Description - This command group provides all commands used to implement an uploader described by an uploader descriptor. - ### SEE ALSO -##### Parents +#### Parents * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_upload_put.md b/docs/pluginreference/plugin_upload_put.md index ba61b055f8..2b8dc30023 100644 --- a/docs/pluginreference/plugin_upload_put.md +++ b/docs/pluginreference/plugin_upload_put.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin upload put [] [] ``` @@ -19,17 +19,15 @@ plugin upload put [] [] ### 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) — upload specific operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_upload_validate.md b/docs/pluginreference/plugin_upload_validate.md index 8a2f1f875b..ec6405dc49 100644 --- a/docs/pluginreference/plugin_upload_validate.md +++ b/docs/pluginreference/plugin_upload_validate.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin upload validate [] [] ``` @@ -16,7 +16,6 @@ plugin upload validate [] [] ### 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 type field must be set. - ### SEE ALSO -##### Parents +#### Parents * [plugin upload](plugin_upload.md) — upload specific operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_valuemergehandler.md b/docs/pluginreference/plugin_valuemergehandler.md index 89d3970016..a096832d2e 100644 --- a/docs/pluginreference/plugin_valuemergehandler.md +++ b/docs/pluginreference/plugin_valuemergehandler.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin valuemergehandler [] ... ``` @@ -13,12 +13,10 @@ plugin valuemergehandler [] ... ``` ### Description - This command group provides all commands used to implement an value merge handlers. - ### SEE ALSO -##### Parents +#### Parents * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_valuemergehandler_execute.md b/docs/pluginreference/plugin_valuemergehandler_execute.md index a2f95a7ac3..19a33e4054 100644 --- a/docs/pluginreference/plugin_valuemergehandler_execute.md +++ b/docs/pluginreference/plugin_valuemergehandler_execute.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin valuemergehandler execute [] ``` @@ -14,7 +14,6 @@ plugin valuemergehandler execute [] ### Description - This command executes a value merge. The values are taken from *stdin* as JSON string. It has the following fields: @@ -41,10 +40,9 @@ following fields: An error message. - ### SEE ALSO -##### Parents +#### Parents * [plugin valuemergehandler](plugin_valuemergehandler.md) — value merge handler operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_valueset.md b/docs/pluginreference/plugin_valueset.md index 81c8c1dad7..3d124b9828 100644 --- a/docs/pluginreference/plugin_valueset.md +++ b/docs/pluginreference/plugin_valueset.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin valueset [] ... ``` @@ -13,13 +13,11 @@ plugin valueset [] ... ``` ### Description - This command group provides all commands used to implement a value set described by a value set descriptor ([plugin descriptor](plugin_descriptor.md). - ### SEE ALSO -##### Parents +#### Parents * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_valueset_compose.md b/docs/pluginreference/plugin_valueset_compose.md index f7513c805b..886093270d 100644 --- a/docs/pluginreference/plugin_valueset_compose.md +++ b/docs/pluginreference/plugin_valueset_compose.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin valueset compose [] ``` @@ -14,7 +14,6 @@ plugin valueset compose [string=YAML: string map with arbitrary values defined by dedicated assignments - string=string: string map defined by dedicated assignments - string=string,string: string map defined by dedicated assignment of comma separated strings - ### SEE ALSO -##### Parents +#### Parents * [plugin valueset](plugin_valueset.md) — valueset operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/pluginreference/plugin_valueset_validate.md b/docs/pluginreference/plugin_valueset_validate.md index cdba2f357c..0c882b1286 100644 --- a/docs/pluginreference/plugin_valueset_validate.md +++ b/docs/pluginreference/plugin_valueset_validate.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh plugin valueset validate [] ``` @@ -14,7 +14,6 @@ plugin valueset validate [] ### Description - This command accepts a value set as argument. It is used to validate the specification and to provide some metadata for the given specification. @@ -26,10 +25,9 @@ following fields: A short textual description of the described value set. - ### SEE ALSO -##### Parents +#### Parents * [plugin valueset](plugin_valueset.md) — valueset operations * [plugin](plugin.md) — OCM Plugin diff --git a/docs/reference/ocm.md b/docs/reference/ocm.md index bf1e08c570..b47624f49d 100644 --- a/docs/reference/ocm.md +++ b/docs/reference/ocm.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm [] ... ``` @@ -29,7 +29,6 @@ ocm [] ... ### Description - The Open Component Model command line client supports the work with OCM artifacts, like Component Archives, Common Transport Archive, Component Repositories, and Component Versions. @@ -353,7 +352,6 @@ With --ca-cert it is possible to define additional root certificates for signature verification, if public keys are provided by a certificate delivered with the signature. - ### SEE ALSO diff --git a/docs/reference/ocm_add.md b/docs/reference/ocm_add.md index c479623e85..8087f15b7b 100644 --- a/docs/reference/ocm_add.md +++ b/docs/reference/ocm_add.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm add [] ... ``` @@ -14,7 +14,7 @@ ocm add [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_componentversions.md b/docs/reference/ocm_add_componentversions.md index 18174e6ae2..b0aa969c0e 100644 --- a/docs/reference/ocm_add_componentversions.md +++ b/docs/reference/ocm_add_componentversions.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add componentversions [] [--version ] [] {} ``` -##### Aliases +#### Aliases -``` +```text componentversions, componentversion, cv, components, component, comps, comp, c ``` @@ -37,7 +37,6 @@ componentversions, componentversion, cv, components, component, comps, comp, c ### Description - Add component versions specified by a constructor file to a Common Transport Archive. The archive might be either a directory prepared to host component version content or a tar/tgz file (see option --type). @@ -212,7 +211,6 @@ The uploader name may be a path expression with the following possibilities: See [ocm ocm-uploadhandlers](ocm_ocm-uploadhandlers.md) for further details on using upload handlers. - ### Examples @@ -259,7 +257,7 @@ next to the description file. ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_componentversions_ocm-labels.md b/docs/reference/ocm_add_componentversions_ocm-labels.md index 4652a06ec6..0e613ca79d 100644 --- a/docs/reference/ocm_add_componentversions_ocm-labels.md +++ b/docs/reference/ocm_add_componentversions_ocm-labels.md @@ -2,7 +2,6 @@ ### Description - Labels are a set of arbitrary properties, which can be attached to elements of a component version: - a component version itself @@ -171,10 +170,9 @@ The following algorithms are possible: The following label assignments are configured: - label:routing-slips: simpleMapMerge - ### SEE ALSO -##### Parents +#### Parents * [ocm add componentversions](ocm_add_componentversions.md) — add component version(s) to a (new) transport archive * [ocm add](ocm_add.md) — Add elements to a component repository or component version diff --git a/docs/reference/ocm_add_references.md b/docs/reference/ocm_add_references.md index ddae161009..41d76d17e0 100644 --- a/docs/reference/ocm_add_references.md +++ b/docs/reference/ocm_add_references.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add references [] [] { | =} ``` -##### Aliases +#### Aliases -``` +```text references, reference, refs ``` @@ -39,7 +39,6 @@ references, reference, refs ### Description - Add aggregation information specified in a reference file to a component version. So far only component archives are supported as target. @@ -156,7 +155,6 @@ There are several templaters that can be selected by the --templater - ### Examples @@ -188,7 +186,7 @@ $ ocm add references path/to/ca references.yaml VERSION=1.0.0 ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_resource-configuration.md b/docs/reference/ocm_add_resource-configuration.md index 19b89ca832..f86c4e3f2a 100644 --- a/docs/reference/ocm_add_resource-configuration.md +++ b/docs/reference/ocm_add_resource-configuration.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add resource-configuration [] { | =} ``` -##### Aliases +#### Aliases -``` +```text resource-configuration, resourceconfig, rsccfg, rcfg ``` @@ -101,7 +101,6 @@ resource-configuration, resourceconfig, rsccfg, rcfg ### Description - Add a resource specification to a resource config file used by [ocm add resources](ocm_add_resources.md). It is possible to describe a single resource via command line options. @@ -972,7 +971,6 @@ There are several templaters that can be selected by the --templater - ### Examples ``` @@ -981,7 +979,7 @@ $ ocm add resource-configuration resources.yaml --name myresource --type PlainTe ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md index 6265a41af7..a1b624b102 100644 --- a/docs/reference/ocm_add_resources.md +++ b/docs/reference/ocm_add_resources.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add resources [] [] { | =} ``` -##### Aliases +#### Aliases -``` +```text resources, resource, res, r ``` @@ -108,7 +108,6 @@ resources, resource, res, r ### Description - Adds resources specified in a resource file to a component version. So far, only component archives are supported as target. @@ -989,7 +988,6 @@ There are several templaters that can be selected by the --templater - ### Examples @@ -1025,7 +1023,7 @@ $ ocm add resources ‐‐file path/to/ca resources.yaml VERSION=1.0.0 ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_routingslips.md b/docs/reference/ocm_add_routingslips.md index ce8478ffa4..8636dd0427 100644 --- a/docs/reference/ocm_add_routingslips.md +++ b/docs/reference/ocm_add_routingslips.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add routingslips [] ``` -##### Aliases +#### Aliases -``` +```text routingslips, routingslip, rs ``` @@ -33,7 +33,6 @@ routingslips, routingslip, rs ### Description - Add a routing slip entry for the specified routing slip name to the given component version. The name is typically a DNS domain name followed by some qualifiers separated by a slash (/). It is possible to use arbitrary types, @@ -114,7 +113,6 @@ it only contains a single component version. Therefore, in this scenario this option must always be specified to be able to follow component references. - ### Examples ``` @@ -123,7 +121,7 @@ $ ocm add routingslip ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev mandels ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_source-configuration.md b/docs/reference/ocm_add_source-configuration.md index 9626b9a720..aaafe7acb7 100644 --- a/docs/reference/ocm_add_source-configuration.md +++ b/docs/reference/ocm_add_source-configuration.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add source-configuration [] { | =} ``` -##### Aliases +#### Aliases -``` +```text source-configuration, sourceconfig, srccfg, scfg ``` @@ -100,7 +100,6 @@ source-configuration, sourceconfig, srccfg, scfg ### Description - Add a source specification to a source config file used by [ocm add sources](ocm_add_sources.md). It is possible to describe a single source via command line options. @@ -972,7 +971,6 @@ There are several templaters that can be selected by the --templater - ### Examples ``` @@ -981,7 +979,7 @@ $ ocm add source-config sources.yaml --name sources --type filesystem --access ' ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md index 34903cf46a..df2e70be1f 100644 --- a/docs/reference/ocm_add_sources.md +++ b/docs/reference/ocm_add_sources.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm add sources [] [] { | =} ``` -##### Aliases +#### Aliases -``` +```text sources, source, src, s ``` @@ -106,7 +106,6 @@ sources, source, src, s ### Description - Add information about the sources, e.g. commits in a Github repository, that have been used to create the resources specified in a resource file to a component version. So far only component archives are supported as target. @@ -987,7 +986,6 @@ There are several templaters that can be selected by the --templater - ### Examples ``` @@ -996,7 +994,7 @@ $ ocm add sources --file path/to/cafile sources.yaml ### SEE ALSO -##### Parents +#### Parents * [ocm add](ocm_add.md) — Add elements to a component repository or component version * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_attributes.md b/docs/reference/ocm_attributes.md index 48124fd901..fbebdab82d 100644 --- a/docs/reference/ocm_attributes.md +++ b/docs/reference/ocm_attributes.md @@ -2,7 +2,6 @@ ### Description - The OCM library supports a set of attributes, which can be used to influence the behaviour of various functions. The CLI also supports setting of those attributes using the config file (see [ocm configfile](ocm_configfile.md)) or by @@ -206,10 +205,9 @@ OCM library: - *rekorURL* *string* default is https://rekor.sigstore.dev - *OIDCIssuer* *string* default is https://oauth2.sigstore.dev/auth - *OIDCClientID* *string* default is sigstore - ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_bootstrap.md b/docs/reference/ocm_bootstrap.md index 14ed4fb875..76770d70d8 100644 --- a/docs/reference/ocm_bootstrap.md +++ b/docs/reference/ocm_bootstrap.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm bootstrap [] ... ``` @@ -14,7 +14,7 @@ ocm bootstrap [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_bootstrap_configuration.md b/docs/reference/ocm_bootstrap_configuration.md index e7609ec4cb..40b29c9e71 100644 --- a/docs/reference/ocm_bootstrap_configuration.md +++ b/docs/reference/ocm_bootstrap_configuration.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm bootstrap configuration [] {} {} ``` -##### Aliases +#### Aliases -``` +```text configuration, config, cfg ``` @@ -24,7 +24,6 @@ configuration, config, cfg ### Description - If a TOI package provides information for configuration file templates/prototypes this command extracts this data and provides appropriate files in the filesystem. @@ -95,7 +94,6 @@ it only contains a single component version. Therefore, in this scenario this option must always be specified to be able to follow component references. - ### Examples ``` @@ -104,7 +102,7 @@ $ ocm toi bootstrap config ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev ### SEE ALSO -##### Parents +#### Parents * [ocm bootstrap](ocm_bootstrap.md) — bootstrap components * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_bootstrap_configuration_toi-bootstrapping.md b/docs/reference/ocm_bootstrap_configuration_toi-bootstrapping.md index f40b3daee0..8795110f04 100644 --- a/docs/reference/ocm_bootstrap_configuration_toi-bootstrapping.md +++ b/docs/reference/ocm_bootstrap_configuration_toi-bootstrapping.md @@ -2,7 +2,6 @@ ### Description - TOI is a small toolset on top of the Open Component Model. It provides a possibility to run images taken from a component version with user configuration and feed them with the content of this component version. @@ -400,7 +399,6 @@ Basically the output may contain any data, but is strongly recommended to use yaml or json files, only. This enables further formal processing by the TOI toolset. - ### Examples ``` @@ -452,7 +450,7 @@ additionalResources: ### SEE ALSO -##### Parents +#### Parents * [ocm bootstrap configuration](ocm_bootstrap_configuration.md) — bootstrap TOI configuration files * [ocm bootstrap](ocm_bootstrap.md) — bootstrap components diff --git a/docs/reference/ocm_bootstrap_package.md b/docs/reference/ocm_bootstrap_package.md index acfaf415af..60c2515653 100644 --- a/docs/reference/ocm_bootstrap_package.md +++ b/docs/reference/ocm_bootstrap_package.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm bootstrap package [] {} {} ``` -##### Aliases +#### Aliases -``` +```text package, pkg, componentversion, cv, component, comp, c ``` @@ -27,7 +27,6 @@ package, pkg, componentversion, cv, component, comp, c ### Description - Use the simple TOI bootstrap mechanism to execute actions for a TOI package resource based on the content of an OCM component version and some command input describing the dedicated installation target. @@ -176,7 +175,6 @@ it only contains a single component version. Therefore, in this scenario this option must always be specified to be able to follow component references. - ### Examples ``` @@ -185,7 +183,7 @@ $ ocm toi bootstrap package ghcr.io/mandelsoft/ocm//ocmdemoinstaller:0.0.1-dev ### SEE ALSO -##### Parents +#### Parents * [ocm bootstrap](ocm_bootstrap.md) — bootstrap components * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_bootstrap_package_toi-bootstrapping.md b/docs/reference/ocm_bootstrap_package_toi-bootstrapping.md index 2fb9215c24..b777d84361 100644 --- a/docs/reference/ocm_bootstrap_package_toi-bootstrapping.md +++ b/docs/reference/ocm_bootstrap_package_toi-bootstrapping.md @@ -2,7 +2,6 @@ ### Description - TOI is a small toolset on top of the Open Component Model. It provides a possibility to run images taken from a component version with user configuration and feed them with the content of this component version. @@ -400,7 +399,6 @@ Basically the output may contain any data, but is strongly recommended to use yaml or json files, only. This enables further formal processing by the TOI toolset. - ### Examples ``` @@ -452,7 +450,7 @@ additionalResources: ### SEE ALSO -##### Parents +#### Parents * [ocm bootstrap package](ocm_bootstrap_package.md) — bootstrap component version * [ocm bootstrap](ocm_bootstrap.md) — bootstrap components diff --git a/docs/reference/ocm_cache.md b/docs/reference/ocm_cache.md index 9ec1ae5c2b..b664b59986 100644 --- a/docs/reference/ocm_cache.md +++ b/docs/reference/ocm_cache.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm cache [] ... ``` @@ -14,7 +14,7 @@ ocm cache [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_check.md b/docs/reference/ocm_check.md index 0d3a7b9f2a..c2f99a3d98 100644 --- a/docs/reference/ocm_check.md +++ b/docs/reference/ocm_check.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm check [] ... ``` @@ -14,7 +14,7 @@ ocm check [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_check_componentversions.md b/docs/reference/ocm_check_componentversions.md index 03860c1dab..699c0b98e2 100644 --- a/docs/reference/ocm_check_componentversions.md +++ b/docs/reference/ocm_check_componentversions.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm check componentversions [] {} ``` -##### Aliases +#### Aliases -``` +```text componentversions, componentversion, cv, components, component, comps, comp, c ``` @@ -26,7 +26,6 @@ componentversions, componentversion, cv, components, component, comps, comp, c ### Description - This command checks, whether component versions are completely contained in an OCM repository with all its dependent component references. @@ -87,7 +86,6 @@ The following modes are supported: - wide - yaml - ### Examples ``` @@ -97,7 +95,7 @@ $ ocm get componentversion --repo OCIRegistry::ghcr.io mandelsoft/kubelink ### SEE ALSO -##### Parents +#### Parents * [ocm check](ocm_check.md) — check components in OCM repository * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_clean.md b/docs/reference/ocm_clean.md index 164d8875b4..eb142aca23 100644 --- a/docs/reference/ocm_clean.md +++ b/docs/reference/ocm_clean.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm clean [] ... ``` @@ -14,7 +14,7 @@ ocm clean [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_clean_cache.md b/docs/reference/ocm_clean_cache.md index 133dd3105a..c43d1b3fab 100644 --- a/docs/reference/ocm_clean_cache.md +++ b/docs/reference/ocm_clean_cache.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm clean cache [] ``` @@ -16,10 +16,8 @@ ocm clean cache [] ### Description - Cleanup all blobs stored in oci blob cache (if given). - ### Examples ``` @@ -28,7 +26,7 @@ $ ocm clean cache ### SEE ALSO -##### Parents +#### Parents * [ocm clean](ocm_clean.md) — Cleanup/re-organize elements * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_configfile.md b/docs/reference/ocm_configfile.md index 2e28cd951f..1949d1e712 100644 --- a/docs/reference/ocm_configfile.md +++ b/docs/reference/ocm_configfile.md @@ -2,7 +2,6 @@ ### Description - The command line client supports configuring by a given configuration file. If existent, by default, the file $HOME/.ocmconfig will be read. Using the option --config an alternative file can be specified. @@ -326,7 +325,6 @@ The following configuration types are supported: ... - ### Examples ``` @@ -350,7 +348,7 @@ configurations: ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_controller.md b/docs/reference/ocm_controller.md index e74255bbaa..1f61cdb543 100644 --- a/docs/reference/ocm_controller.md +++ b/docs/reference/ocm_controller.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm controller [] ... ``` @@ -14,7 +14,7 @@ ocm controller [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_controller_install.md b/docs/reference/ocm_controller_install.md index 3c597bb1d4..a56fe2de7e 100644 --- a/docs/reference/ocm_controller_install.md +++ b/docs/reference/ocm_controller_install.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm controller install controller {--version v0.0.1} ``` @@ -27,7 +27,7 @@ ocm controller install controller {--version v0.0.1} ### SEE ALSO -##### Parents +#### Parents * [ocm controller](ocm_controller.md) — Commands acting on the ocm-controller * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_controller_uninstall.md b/docs/reference/ocm_controller_uninstall.md index 21f3ce288c..ed39f08925 100644 --- a/docs/reference/ocm_controller_uninstall.md +++ b/docs/reference/ocm_controller_uninstall.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm controller uninstall controller ``` @@ -26,7 +26,7 @@ ocm controller uninstall controller ### SEE ALSO -##### Parents +#### Parents * [ocm controller](ocm_controller.md) — Commands acting on the ocm-controller * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_create.md b/docs/reference/ocm_create.md index f3f37341e6..776bc2980f 100644 --- a/docs/reference/ocm_create.md +++ b/docs/reference/ocm_create.md @@ -2,7 +2,7 @@ ### Synopsis -``` +```sh ocm create [] ... ``` @@ -14,7 +14,7 @@ ocm create [] ... ### SEE ALSO -##### Parents +#### Parents * [ocm](ocm.md) — Open Component Model command line client diff --git a/docs/reference/ocm_create_componentarchive.md b/docs/reference/ocm_create_componentarchive.md index e56306ad7f..096893e603 100644 --- a/docs/reference/ocm_create_componentarchive.md +++ b/docs/reference/ocm_create_componentarchive.md @@ -2,13 +2,13 @@ ### Synopsis -``` +```sh ocm create componentarchive [] --provider {--provider