diff --git a/config/commands.yaml b/config/commands.yaml index 22d5f98..da0eff2 100644 --- a/config/commands.yaml +++ b/config/commands.yaml @@ -29,6 +29,9 @@ options: description: | Raise an error if the operation does not complete in the given period of time. + links: + - name: Duration format + url: https://pkg.go.dev/time#ParseDuration update/name: name: name type: string @@ -385,12 +388,12 @@ commands: - name: start platforms: [Docker, Podman, Systemd] description: | - Start the Skupper router for the current site. + Start running the Skupper components for the current site. # site.stop - name: stop platforms: [Docker, Podman, Systemd] description: | - Stop the Skupper router for the current site. + Shut down the Skupper components for the current site. # site.reload - name: reload platforms: [Docker, Podman, Systemd] diff --git a/input/commands/connector/create.md b/input/commands/connector/create.md index 5de33c3..d87d8c7 100644 --- a/input/commands/connector/create.md +++ b/input/commands/connector/create.md @@ -77,7 +77,7 @@ $ skupper connector create backend 8080 --routing-key be1 --workload deployment/ period of time. <table class="fields"><tr><th>Default</th><td><p><code>60s</code></p> - </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table> + </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table> - <div class="attribute"><h3 id="option-routing-key">--routing-key</h3><div><string></div></div> diff --git a/input/commands/connector/status.md b/input/commands/connector/status.md index b3b3f1e..390cc51 100644 --- a/input/commands/connector/status.md +++ b/input/commands/connector/status.md @@ -55,7 +55,7 @@ Listeners: 1 ## Options -- <div class="attribute"><h3 id="option-name"><name></h3><div>string, optional</div></div> +- <div class="attribute"><h3 id="option-name">[name]</h3><div>string, optional</div></div> An optional resource name. If set, the status command reports status for the named resource only. diff --git a/input/commands/index.md b/input/commands/index.md index 09a1cb1..ddbc6cb 100644 --- a/input/commands/index.md +++ b/input/commands/index.md @@ -22,9 +22,9 @@ links: </td></tr> <tr><th><a href="{{site_prefix}}/commands/site/generate.html">Site generate</a></th><td><p>Generate a Site resource</p> </td></tr> -<tr><th><a href="{{site_prefix}}/commands/site/start.html">Site start</a></th><td><p>Start the Skupper router for the current site</p> +<tr><th><a href="{{site_prefix}}/commands/site/start.html">Site start</a></th><td><p>Start running the Skupper components for the current site</p> </td></tr> -<tr><th><a href="{{site_prefix}}/commands/site/stop.html">Site stop</a></th><td><p>Stop the Skupper router for the current site</p> +<tr><th><a href="{{site_prefix}}/commands/site/stop.html">Site stop</a></th><td><p>Shut down the Skupper components for the current site</p> </td></tr> <tr><th><a href="{{site_prefix}}/commands/site/reload.html">Site reload</a></th><td><p>Reload the site configuration</p> </td></tr> diff --git a/input/commands/link/status.md b/input/commands/link/status.md index bf391fd..d8ee623 100644 --- a/input/commands/link/status.md +++ b/input/commands/link/status.md @@ -55,7 +55,7 @@ Cost: 1 ## Options -- <div class="attribute"><h3 id="option-name"><name></h3><div>string, optional</div></div> +- <div class="attribute"><h3 id="option-name">[name]</h3><div>string, optional</div></div> An optional resource name. If set, the status command reports status for the named resource only. diff --git a/input/commands/link/update.md b/input/commands/link/update.md index 238e90b..85cd28d 100644 --- a/input/commands/link/update.md +++ b/input/commands/link/update.md @@ -66,7 +66,7 @@ Link "west-6bfn6" is ready. period of time. <table class="fields"><tr><th>Default</th><td><p><code>60s</code></p> - </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table> + </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table> - <div class="attribute"><h3 id="option-cost">--cost</h3><div><integer></div></div> diff --git a/input/commands/listener/create.md b/input/commands/listener/create.md index 40f2031..c889cf3 100644 --- a/input/commands/listener/create.md +++ b/input/commands/listener/create.md @@ -79,7 +79,7 @@ $ skupper listener create backend 8080 --routing-key be1 --host apiserver period of time. <table class="fields"><tr><th>Default</th><td><p><code>60s</code></p> - </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table> + </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table> - <div class="attribute"><h3 id="option-routing-key">--routing-key</h3><div><string></div></div> diff --git a/input/commands/listener/status.md b/input/commands/listener/status.md index ee9ba96..e18e93b 100644 --- a/input/commands/listener/status.md +++ b/input/commands/listener/status.md @@ -54,7 +54,7 @@ Connectors: 1 ## Options -- <div class="attribute"><h3 id="option-name"><name></h3><div>string, optional</div></div> +- <div class="attribute"><h3 id="option-name">[name]</h3><div>string, optional</div></div> An optional resource name. If set, the status command reports status for the named resource only. diff --git a/input/commands/site/create.md b/input/commands/site/create.md index 8f68cde..0c249fc 100644 --- a/input/commands/site/create.md +++ b/input/commands/site/create.md @@ -70,7 +70,7 @@ $ skupper site create west --enable-link-access period of time. <table class="fields"><tr><th>Default</th><td><p><code>60s</code></p> - </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td></table> + </td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Systemd</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table> - <div class="attribute"><h3 id="option-enable-link-access">--enable-link-access</h3><div>boolean</div></div> diff --git a/input/commands/site/delete.md b/input/commands/site/delete.md index 0439c98..9c71f7a 100644 --- a/input/commands/site/delete.md +++ b/input/commands/site/delete.md @@ -47,7 +47,7 @@ $ skupper site delete --all ## Options -- <div class="attribute"><h3 id="option-name"><name></h3><div>string, optional</div></div> +- <div class="attribute"><h3 id="option-name">[name]</h3><div>string, optional</div></div> The name of the site resource. diff --git a/input/commands/site/index.md b/input/commands/site/index.md index 0e61cf0..5219ef8 100644 --- a/input/commands/site/index.md +++ b/input/commands/site/index.md @@ -40,9 +40,9 @@ skupper site [command] [options] </td></tr> <tr><th><a href="generate.html">Site generate</a></th><td><p>Generate a Site resource</p> </td></tr> -<tr><th><a href="start.html">Site start</a></th><td><p>Start the Skupper router for the current site</p> +<tr><th><a href="start.html">Site start</a></th><td><p>Start running the Skupper components for the current site</p> </td></tr> -<tr><th><a href="stop.html">Site stop</a></th><td><p>Stop the Skupper router for the current site</p> +<tr><th><a href="stop.html">Site stop</a></th><td><p>Shut down the Skupper components for the current site</p> </td></tr> <tr><th><a href="reload.html">Site reload</a></th><td><p>Reload the site configuration</p> </td></tr> diff --git a/input/commands/site/start.md b/input/commands/site/start.md index f267f0f..36b4293 100644 --- a/input/commands/site/start.md +++ b/input/commands/site/start.md @@ -11,7 +11,7 @@ links: <section> -Start the Skupper router for the current site. +Start running the Skupper components for the current site. <table class="fields"><tr><th>Platforms</th><td>Docker, Podman, Systemd</td></table> diff --git a/input/commands/site/status.md b/input/commands/site/status.md index 5763df3..72828f9 100644 --- a/input/commands/site/status.md +++ b/input/commands/site/status.md @@ -45,7 +45,7 @@ Message: - ## Options -- <div class="attribute"><h3 id="option-name"><name></h3><div>string, optional</div></div> +- <div class="attribute"><h3 id="option-name">[name]</h3><div>string, optional</div></div> An optional resource name. If set, the status command reports status for the named resource only. diff --git a/input/commands/site/stop.md b/input/commands/site/stop.md index d52b02d..8d8fb87 100644 --- a/input/commands/site/stop.md +++ b/input/commands/site/stop.md @@ -11,7 +11,7 @@ links: <section> -Stop the Skupper router for the current site. +Shut down the Skupper components for the current site. <table class="fields"><tr><th>Platforms</th><td>Docker, Podman, Systemd</td></table> diff --git a/input/commands/site/update.md b/input/commands/site/update.md index 3f6a6cd..ab90b24 100644 --- a/input/commands/site/update.md +++ b/input/commands/site/update.md @@ -47,7 +47,7 @@ $ skupper site update --enable-link-access --service-account alice ## Options -- <div class="attribute"><h3 id="option-name"><name></h3><div>string, optional</div></div> +- <div class="attribute"><h3 id="option-name">[name]</h3><div>string, optional</div></div> The name of the site resource. diff --git a/input/main.css b/input/main.css index 77a99be..2b8a499 100644 --- a/input/main.css +++ b/input/main.css @@ -360,7 +360,7 @@ body.object main::after { } table.objects th { - width: 10em; + width: 14em; text-align: left; font-weight: normal; } diff --git a/python/commands.py b/python/commands.py index 740e6bd..3008eea 100644 --- a/python/commands.py +++ b/python/commands.py @@ -221,7 +221,10 @@ def generate_option(option, append): option_info = option.type if option.positional: - option_key = f"<{option_key}>" + if option.required: + option_key = f"<{option_key}>" + else: + option_key = f"[{option_key}]" else: option_key = f"--{option_key}"