WIP

config/config.py

@@ -43,7 +43,7 @@ def refdog_links(page):
 
 def refdog_toc(page):
     if not page.metadata.get("refdog_toc"):
-        return ""
+        return "<section id=\"-toc\"></section>"
 
     lines = list()
 

input/commands/connector/create.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Create a connector.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
-
 ~~~ shell
 skupper connector create <name> <port> [options]
 ~~~
 
+Create a connector.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
+
 </section>
 
 <section>

input/commands/connector/delete.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Delete a connector.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Deletion</td></table>
-
 ~~~ shell
 skupper connector delete <name> [options]
 ~~~
 
+Delete a connector.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Deletion</td></table>
+
 </section>
 
 <section>

input/commands/connector/generate.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Generate a Connector resource.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper connector generate <name> <port> [options]
 ~~~
 
+Generate a Connector resource.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/connector/index.md

@@ -25,12 +25,12 @@ refdog_toc:
 
 <section>
 
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper connector [subcommand] [options]
 ~~~
 
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/connector/status.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Display the status of connectors in the current site.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper connector status [name] [options]
 ~~~
 
+Display the status of connectors in the current site.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/connector/update.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Update a connector.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
-
 ~~~ shell
 skupper connector update <name> <port> [options]
 ~~~
 
+Update a connector.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
+
 </section>
 
 <section>

input/commands/debug/check.md

@@ -15,14 +15,14 @@ refdog_toc:
 
 <section>
 
-Run diagnostic checks.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper debug check [options]
 ~~~
 
+Run diagnostic checks.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section class="attributes">

input/commands/debug/dump.md

@@ -19,15 +19,15 @@ refdog_toc:
 
 <section>
 
+~~~ shell
+skupper debug dump [file] [options]
+~~~
+
 Generate a debug dump file.  Debug dumps collect the details of
 a site so another party can identify and fix a problem.
 
 <table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
 
-~~~ shell
-skupper debug dump [file] [options]
-~~~
-
 </section>
 
 <section>

input/commands/debug/index.md

@@ -17,12 +17,12 @@ refdog_toc:
 
 <section>
 
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper debug [subcommand] [options]
 ~~~
 
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/link/delete.md

@@ -23,14 +23,14 @@ refdog_toc:
 
 <section>
 
-Delete a link.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Deletion</td></table>
-
 ~~~ shell
 skupper link delete <name> [options]
 ~~~
 
+Delete a link.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Deletion</td></table>
+
 </section>
 
 <section>

input/commands/link/generate.md

@@ -23,6 +23,10 @@ refdog_toc:
 
 <section>
 
+~~~ shell
+skupper link generate [name] [options]
+~~~
+
 Generate a Link resource for use in a remote site.
 
 Generating a link requires a site with link access enabled.
@@ -31,10 +35,6 @@ before producing the link.
 
 <table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Site resource Ready</td></table>
 
-~~~ shell
-skupper link generate [name] [options]
-~~~
-
 </section>
 
 <section>

input/commands/link/index.md

@@ -25,12 +25,12 @@ refdog_toc:
 
 <section>
 
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper link [subcommand] [options]
 ~~~
 
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/link/status.md

@@ -23,14 +23,14 @@ refdog_toc:
 
 <section>
 
-Display the status of links in the current site.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper link status [name] [options]
 ~~~
 
+Display the status of links in the current site.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/link/update.md

@@ -23,14 +23,14 @@ refdog_toc:
 
 <section>
 
-Change link settings.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Ready</td></table>
-
 ~~~ shell
 skupper link update <name> [options]
 ~~~
 
+Change link settings.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Ready</td></table>
+
 </section>
 
 <section>

input/commands/listener/create.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Create a listener.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
-
 ~~~ shell
 skupper listener create <name> <port> [options]
 ~~~
 
+Create a listener.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
+
 </section>
 
 <section>

input/commands/listener/delete.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Delete a listener.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Deletion</td></table>
-
 ~~~ shell
 skupper listener delete <name> [options]
 ~~~
 
+Delete a listener.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Deletion</td></table>
+
 </section>
 
 <section>

input/commands/listener/generate.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Generate a Listener resource.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper listener generate <name> <port> [options]
 ~~~
 
+Generate a Listener resource.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/listener/index.md

@@ -25,12 +25,12 @@ refdog_toc:
 
 <section>
 
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper listener [subcommand] [options]
 ~~~
 
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/listener/status.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Display the status of listeners in the current site.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
-
 ~~~ shell
 skupper listener status [name] [options]
 ~~~
 
+Display the status of listeners in the current site.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
+
 </section>
 
 <section>

input/commands/listener/update.md

@@ -25,14 +25,14 @@ refdog_toc:
 
 <section>
 
-Update a listener.
-
-<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
-
 ~~~ shell
 skupper listener update <name> [options]
 ~~~
 
+Update a listener.
+
+<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Waits for</th><td>Configured</td></table>
+
 </section>
 
 <section>

input/commands/overview.md

@@ -14,9 +14,9 @@ for creating and operating Skupper networks.
 #### Capabilities
 
 The Skupper CLI is a light layer on top of the standard Skupper
-resources.  Its main job is to configure Skupper resources.  It
-additionally provides commands for site linking, system operation, and
-troubleshooting.
+resources.  Its main job is to configure Skupper sites, listeners, and
+connectors.  It additionally provides commands for site linking,
+system operation, and troubleshooting.
 
 - **Resource configuration:** Create, update, and delete Skupper
   resources.