Merge pull request #170 from open-component-model/add-config-and-exam…

…ples minor changes
open-component-model · Dec 11, 2023 · 08a6ccd · 08a6ccd
2 parents 704702e + 1e33912
commit 08a6ccd
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 14 deletions.
diff --git a/content/en/docs/cli-reference/configfile/_index.md b/content/en/docs/cli-reference/configfile/_index.md
@@ -1,6 +1,6 @@
 ---
-title: Config file
-name: Config file
+title: Config File
+name: Config File
 url: /docs/cli/configfile/
 date: 2023-12-11T10:43:19Z
 draft: false
@@ -11,6 +11,7 @@ menu:
 toc: true
 isCommand: false
 ---
+
 ### Description
 
 The command line client supports configuration using a configuration file.
@@ -19,7 +20,9 @@ Using the option <code>--config</code> an alternative file can be specified.
 
 ### Configuration File Syntax
 For a detailed description of the configuration file structure and all possible attributes see
-* [Config File Syntax](/docs/cli/configfile_syntax.md)	 &mdash; OCM CLI configuration file syntax
+* [Config File Syntax](/docs/cli/configfile/syntax)	 &mdash; OCM CLI configuration file syntax
 
 ### Examples
-* [Config File Examples](/docs/cli/configfile_examples.md)	 &mdash; OCM CLI configuration file examples
+* [Config File Examples](/docs/cli/configfile/examples)	 &mdash; OCM CLI configuration file examples
+
+###
diff --git a/content/en/docs/cli-reference/configfile/configfile_examples.md b/content/en/docs/cli-reference/configfile/configfile_examples.md
@@ -1,20 +1,18 @@
 ---
 title: Config File Examples
 name: Config File Examples
-url: /docs/cli/configfile/examples
+url: /docs/cli/configfile/examples/
 date: 2023-12-11T10:43:19Z
 draft: false
 images: []
 menu:
   docs:
     parent: configfile
 toc: true
-isCommand: true
+isCommand: false
 ---
 
-### Examples for .ocmconfig files
-
-Pointing the configuration to an existing Docker config json:
+### Reference an existing Docker config.json:
 
 ```yaml
 type: generic.config.ocm.software/v1
@@ -27,7 +25,9 @@ configurations:
           propagateConsumerIdentity: true
 ```
 
-Pointing to an existing Docker config json and configure two additional consumers
+### Configure multiple Consumers, Cache and Signing
+
+Configuring an existing Docker config json and two additional consumers
 for a Github repository and a Helm chart repository.
 Caching for OCM component versions is switched on.
 A key pair for signing / verifiying OCM component versions has been configured, too.
@@ -69,4 +69,8 @@ configurations:
     publicKeys:
       sap.com:
         path: /Users/myuser/.ocm/keys/mycomp.com.pub
-```
+```
+
+### See Also
+
+* [Config File](/docs/cli/configfile)	 &mdash; OCM CLI configuration file
diff --git a/content/en/docs/cli-reference/configfile/configfile_syntax.md b/content/en/docs/cli-reference/configfile/configfile_syntax.md
@@ -1,7 +1,7 @@
 ---
 title: Config File Syntax
 name: Config File Syntax
-url: /docs/cli/configfile/sytnax/
+url: /docs/cli/configfile/syntax/
 date: 2023-12-11T10:43:19Z
 draft: false
 images: []
@@ -12,7 +12,7 @@ toc: true
 isCommand: false
 ---
 
-### Configuration File Syntax
+### Description
 
 The command line client supports configuration using a configuration file.
 If existent, by default, the file <code>$HOME/.ocmconfig</code> will be read.
@@ -353,4 +353,8 @@ configurations:
     publicKeys:
       sap.com:
         path: /Users/myuser/.ocm/keys/mycomp.com.pub
-```
+```
+
+### See Also
+
+* [Config File](/docs/cli/configfile)	 &mdash; OCM CLI configuration file