WIP

skupperproject · Jan 2, 2025 · 078a428 · 078a428
1 parent 7bc35f0
commit 078a428
Show file tree

Hide file tree

Showing 24 changed files with 84 additions and 77 deletions.
diff --git a/config/commands/options.yaml b/config/commands/options.yaml
@@ -10,6 +10,7 @@ create/timeout:
   type: string
   placeholder: duration
   default: 60s
+  platforms: [Kubernetes]
   links: [kubernetes/duration_format]
   description: |
     Raise an error if the operation does not complete in the given
@@ -19,6 +20,7 @@ create/wait:
   type: string
   placeholder: status
   default: ready
+  platforms: [Kubernetes]
   links: [skupper/resource_status]
   description: |
     Wait for the given status before exiting.
@@ -41,6 +43,7 @@ update/timeout:
   type: string
   placeholder: duration
   default: 60s
+  platforms: [Kubernetes]
   description: |
     Raise an error if the operation does not complete in the given
     period of time.
@@ -49,6 +52,7 @@ update/wait:
   type: string
   placeholder: status
   default: ready
+  platforms: [Kubernetes]
   links: [skupper/resource_status]
   description: |
     Wait for the given status before exiting.
@@ -71,13 +75,15 @@ delete/timeout:
   type: string
   placeholder: duration
   default: 60s
+  platforms: [Kubernetes]
   description: |
     Raise an error if the operation does not complete in the given
     period of time.
 delete/wait:
   name: wait
   type: boolean
   default: true
+  platforms: [Kubernetes]
   description: |
     Wait for deletion to complete before exiting.
 status/name:
@@ -94,6 +100,7 @@ status/timeout:
   type: string
   placeholder: duration
   default: 60s
+  platforms: [Kubernetes]
   links: [kubernetes/duration_format]
   description: |
     Raise an error if the operation does not complete in the given

diff --git a/input/commands/connector/create.md b/input/commands/connector/create.md
@@ -154,7 +154,7 @@ This is an alternative to setting the `--selector` or
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">&lt;status&gt;</div>
@@ -167,12 +167,12 @@ Wait for the given status before exiting.
 </td><tr><th>Choices</th><td><table class="choices"><tr><th><code>none</code></th><td><p>Do not wait.</p>
 </td></tr><tr><th><code>configured</code></th><td><p>Wait until the configuration is applied.</p>
 </td></tr><tr><th><code>ready</code></th><td><p>Wait until the resource is ready to use.</p>
-</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
+</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -183,7 +183,7 @@ Raise an error if the operation does not complete in the given
 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, Linux</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
 
 </div>
 </div>

diff --git a/input/commands/connector/delete.md b/input/commands/connector/delete.md
@@ -48,7 +48,7 @@ The name of the resource to be deleted.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -59,12 +59,12 @@ Raise an error if the operation does not complete in the given
 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, Linux</td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">boolean</div>
@@ -73,7 +73,7 @@ period of time.
 
 Wait for deletion to complete before exiting.
 
-<table class="fields"><tr><th>Default</th><td>true</td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+<table class="fields"><tr><th>Default</th><td>true</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>

diff --git a/input/commands/connector/generate.md b/input/commands/connector/generate.md
@@ -151,7 +151,7 @@ This is an alternative to setting the `--selector` or
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">&lt;status&gt;</div>
@@ -169,7 +169,7 @@ Wait for the given status before exiting.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-output">--output</h3>
 <div class="attribute-type-info">(-o) &lt;format&gt;</div>

diff --git a/input/commands/connector/status.md b/input/commands/connector/status.md
@@ -61,7 +61,7 @@ status for the named resource only.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -72,12 +72,12 @@ Raise an error if the operation does not complete in the given
 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, Linux</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-output">--output</h3>
 <div class="attribute-type-info">(-o) &lt;format&gt;</div>

diff --git a/input/commands/connector/update.md b/input/commands/connector/update.md
@@ -145,7 +145,7 @@ This is an alternative to setting the `--selector` or
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">&lt;status&gt;</div>
@@ -158,12 +158,12 @@ Wait for the given status before exiting.
 </td><tr><th>Choices</th><td><table class="choices"><tr><th><code>none</code></th><td><p><em>Do not wait</em></p>
 </td></tr><tr><th><code>configured</code></th><td><p>Configured</p>
 </td></tr><tr><th><code>ready</code></th><td><p>Ready</p>
-</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
+</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -174,7 +174,7 @@ Raise an error if the operation does not complete in the given
 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, Linux</td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>

diff --git a/input/commands/link/delete.md b/input/commands/link/delete.md
@@ -46,7 +46,7 @@ The name of the resource to be deleted.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -57,12 +57,12 @@ Raise an error if the operation does not complete in the given
 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, Linux</td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">boolean</div>
@@ -71,7 +71,7 @@ period of time.
 
 Wait for deletion to complete before exiting.
 
-<table class="fields"><tr><th>Default</th><td>true</td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+<table class="fields"><tr><th>Default</th><td>true</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>

diff --git a/input/commands/link/generate.md b/input/commands/link/generate.md
@@ -77,7 +77,7 @@ generated if none is provided.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-cost">--cost</h3>
 <div class="attribute-type-info">&lt;integer&gt;</div>
@@ -92,7 +92,7 @@ the link.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-output">--output</h3>
 <div class="attribute-type-info">(-o) &lt;format&gt;</div>

diff --git a/input/commands/link/status.md b/input/commands/link/status.md
@@ -59,7 +59,7 @@ status for the named resource only.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -70,12 +70,12 @@ Raise an error if the operation does not complete in the given
 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, Linux</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-output">--output</h3>
 <div class="attribute-type-info">(-o) &lt;format&gt;</div>

diff --git a/input/commands/link/update.md b/input/commands/link/update.md
@@ -46,7 +46,7 @@ The name of the resource to be updated.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-cost">--cost</h3>
 <div class="attribute-type-info">&lt;integer&gt;</div>
@@ -61,7 +61,7 @@ the link.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -72,12 +72,12 @@ Raise an error if the operation does not complete in the given
 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, Linux</td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">&lt;status&gt;</div>
@@ -90,7 +90,7 @@ Wait for the given status before exiting.
 </td><tr><th>Choices</th><td><table class="choices"><tr><th><code>none</code></th><td><p><em>Do not wait</em></p>
 </td></tr><tr><th><code>configured</code></th><td><p>Configured</p>
 </td></tr><tr><th><code>ready</code></th><td><p>Ready</p>
-</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
+</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
 
 </div>
 </div>

diff --git a/input/commands/listener/create.md b/input/commands/listener/create.md
@@ -109,7 +109,7 @@ establish connections to the remote service.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">&lt;status&gt;</div>
@@ -122,12 +122,12 @@ Wait for the given status before exiting.
 </td><tr><th>Choices</th><td><table class="choices"><tr><th><code>none</code></th><td><p>Do not wait.</p>
 </td></tr><tr><th><code>configured</code></th><td><p>Wait until the configuration is applied.</p>
 </td></tr><tr><th><code>ready</code></th><td><p>Wait until the resource is ready to use.</p>
-</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
+</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -138,7 +138,7 @@ Raise an error if the operation does not complete in the given
 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, Linux</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="https://pkg.go.dev/time#ParseDuration">Duration format</a></td></table>
 
 </div>
 </div>

diff --git a/input/commands/listener/delete.md b/input/commands/listener/delete.md
@@ -48,7 +48,7 @@ The name of the resource to be deleted.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-timeout">--timeout</h3>
 <div class="attribute-type-info">&lt;duration&gt;</div>
@@ -59,12 +59,12 @@ Raise an error if the operation does not complete in the given
 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, Linux</td></table>
+</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">boolean</div>
@@ -73,7 +73,7 @@ period of time.
 
 Wait for deletion to complete before exiting.
 
-<table class="fields"><tr><th>Default</th><td>true</td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+<table class="fields"><tr><th>Default</th><td>true</td><tr><th>Platforms</th><td>Kubernetes</td></table>
 
 </div>
 </div>

diff --git a/input/commands/listener/generate.md b/input/commands/listener/generate.md
@@ -111,7 +111,7 @@ establish connections to the remote service.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-wait">--wait</h3>
 <div class="attribute-type-info">&lt;status&gt;</div>
@@ -129,7 +129,7 @@ Wait for the given status before exiting.
 </div>
 </div>
 
-<div class="attribute collapsed">
+<div class="attribute">
 <div class="attribute-heading">
 <h3 id="option-output">--output</h3>
 <div class="attribute-type-info">(-o) &lt;format&gt;</div>