Skip to content

Commit

Permalink
just fix uploader documentation (#991)
Browse files Browse the repository at this point in the history
Just doing the documentation fix, without any renaning. NOTHING more!

This is now a replacement of:
#944

renaming might happen with implementation of:
open-component-model/ocm-project#286
  • Loading branch information
hilmarf authored and Skarlso committed Oct 22, 2024
1 parent e5914ad commit 76b86b6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions api/ocm/extensions/blobhandler/config/type.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,16 @@ func (a *Config) ApplyTo(ctx cfgcpi.Context, target interface{}) error {

const usage = `
The config type <code>` + ConfigType + `</code> can be used to define a list
of preconfigured download handler registrations (see <CMD>ocm ocm-downloadhandlers</CMD>):
of preconfigured upload handler registrations (see <CMD>ocm ocm-uploadhandlers</CMD>):
<pre>
type: ` + ConfigType + `
description: "my standard download handler configuration"
description: "my standard upload handler configuration"
handlers:
- name: oci/artifact
artifactType: ociImage
mimeType:
config: ...
config:
ociRef: ghcr.io/open-component-model/...
...
</pre>
`
9 changes: 5 additions & 4 deletions docs/reference/ocm_configfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,16 +312,16 @@ The following configuration types are supported:
</pre>
- <code>uploader.ocm.config.ocm.software</code>
The config type <code>uploader.ocm.config.ocm.software</code> can be used to define a list
of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](ocm_ocm-downloadhandlers.md)):
of preconfigured upload handler registrations (see [ocm ocm-uploadhandlers](ocm_ocm-uploadhandlers.md)):

<pre>
type: uploader.ocm.config.ocm.software
description: "my standard download handler configuration"
description: "my standard upload handler configuration"
handlers:
- name: oci/artifact
artifactType: ociImage
mimeType:
config: ...
config:
ociRef: ghcr.io/open-component-model/...
...
</pre>

Expand Down Expand Up @@ -357,4 +357,5 @@ configurations:
##### Additional Links

* [<b>ocm ocm-downloadhandlers</b>](ocm_ocm-downloadhandlers.md) &mdash; List of all available download handlers
* [<b>ocm ocm-uploadhandlers</b>](ocm_ocm-uploadhandlers.md) &mdash; List of all available upload handlers

0 comments on commit 76b86b6

Please sign in to comment.