From b69a0bef65c733fe17cd71d929fb0d9771537095 Mon Sep 17 00:00:00 2001 From: Justin Ross Date: Thu, 2 Jan 2025 17:07:35 -0500 Subject: [PATCH] WIP --- input/commands/index.md | 4 ++-- input/commands/overview.md | 12 +++++++----- input/concepts/index.md | 4 ++-- input/concepts/overview.md | 6 ++++-- input/index.md | 24 ++++++++++++++++++------ input/resources/index.md | 4 ++-- input/resources/overview.md | 6 ++++-- python/commands.py | 4 ++-- python/concepts.py | 4 ++-- python/generate.py | 33 ++++++++++++++++++--------------- python/resources.py | 4 ++-- 11 files changed, 63 insertions(+), 42 deletions(-) diff --git a/input/commands/index.md b/input/commands/index.md index 7338c3a..709a31c 100644 --- a/input/commands/index.md +++ b/input/commands/index.md @@ -1,5 +1,7 @@ --- refdog_links: + - title: Command overview + url: overview.html - title: Skupper concepts url: /concepts/index.html - title: Skupper resources @@ -8,8 +10,6 @@ refdog_links: # Skupper commands -[Overview](overview.html) - #### Site operations diff --git a/input/commands/overview.md b/input/commands/overview.md index 6dffce4..3baa4b9 100644 --- a/input/commands/overview.md +++ b/input/commands/overview.md @@ -1,8 +1,10 @@ --- refdog_links: - - title: Skupper concept overview + - title: Command index + url: index.html + - title: Concept overview url: /concepts/overview.html - - title: Skupper resource overview + - title: Resource overview url: /resources/overview.html --- @@ -13,9 +15,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 sites, listeners, and -connectors. It additionally provides commands for site linking, +In its primary role, the Skupper CLI is a thin layer on top of the +standard Skupper resources. Its job is to configure sites, listeners, +and connectors. It additionally provides commands for site linking, system operation, and troubleshooting. - **Resource configuration:** Create, update, and delete Skupper diff --git a/input/concepts/index.md b/input/concepts/index.md index 97ca49f..1ba3013 100644 --- a/input/concepts/index.md +++ b/input/concepts/index.md @@ -1,5 +1,7 @@ --- refdog_links: + - title: Concept overview + url: overview.html - title: Skupper resources url: /resources/index.html - title: Skupper commands @@ -8,8 +10,6 @@ refdog_links: # Skupper concepts -[Overview](overview.html) - #### Sites
diff --git a/input/concepts/overview.md b/input/concepts/overview.md index 8abf7bd..7ca6d7b 100644 --- a/input/concepts/overview.md +++ b/input/concepts/overview.md @@ -1,8 +1,10 @@ --- refdog_links: - - title: Skupper resource overview + - title: Concept index + url: index.html + - title: Resource overview url: /resources/overview.html - - title: Skupper command overview + - title: Command overview url: /commands/overview.html --- diff --git a/input/index.md b/input/index.md index 92668fb..fc75c2c 100644 --- a/input/index.md +++ b/input/index.md @@ -4,20 +4,32 @@ body_class: object index # Refdog +
+
+ #### Concepts -- [Overview](concepts/overview.html) -- [Index](concepts/index.html) +[Concept overview](concepts/overview.html)
+[Concept index](concepts/index.html) + +
+
#### Resources -- [Overview](resources/overview.html) -- [Index](resources/index.html) +[Resource overview](resources/overview.html)
+[Resource index](resources/index.html) +
+
+ #### Commands -- [Overview](commands/overview.html) -- [Index](commands/index.html) +[Command overview](commands/overview.html)
+[Command index](commands/index.html) + +
+
diff --git a/input/resources/index.md b/input/resources/index.md index 1be16e2..576b3ff 100644 --- a/input/resources/index.md +++ b/input/resources/index.md @@ -1,5 +1,7 @@ --- refdog_links: + - title: Resource overview + url: overview.html - title: Skupper concepts url: /concepts/index.html - title: Skupper commands @@ -8,8 +10,6 @@ refdog_links: # Skupper resources -[Overview](overview.html) - #### Primary resources
diff --git a/input/resources/overview.md b/input/resources/overview.md index 694b76c..3b7601c 100644 --- a/input/resources/overview.md +++ b/input/resources/overview.md @@ -1,8 +1,10 @@ --- refdog_links: - - title: Skupper concept overview + - title: Resource index + url: index.html + - title: Concept overview url: /concepts/overview.html - - title: Skupper command overview + - title: Command overview url: /commands/overview.html --- diff --git a/python/commands.py b/python/commands.py index bdcc5e4..c6957fc 100644 --- a/python/commands.py +++ b/python/commands.py @@ -9,6 +9,8 @@ def generate(model): append("---") append("refdog_links:") + append(" - title: Command overview") + append(" url: overview.html") append(" - title: Skupper concepts") append(" url: /concepts/index.html") append(" - title: Skupper resources") @@ -17,8 +19,6 @@ def generate(model): append() append("# Skupper commands") append() - append("[Overview](overview.html)") - append() for group in model.groups: append(f"#### {group.title}") diff --git a/python/concepts.py b/python/concepts.py index de9bf7d..6517c54 100644 --- a/python/concepts.py +++ b/python/concepts.py @@ -9,6 +9,8 @@ def generate(model): append("---") append("refdog_links:") + append(" - title: Concept overview") + append(" url: overview.html") append(" - title: Skupper resources") append(" url: /resources/index.html") append(" - title: Skupper commands") @@ -17,8 +19,6 @@ def generate(model): append() append("# Skupper concepts") append() - append("[Overview](overview.html)") - append() for group in model.groups: append(f"#### {group.title}") diff --git a/python/generate.py b/python/generate.py index 87be063..558d33f 100644 --- a/python/generate.py +++ b/python/generate.py @@ -37,36 +37,39 @@ def generate_index(): append() append("# Refdog") append() + append("
") + append("
") + append() append("#### Concepts") append() - append("- [Overview](concepts/overview.html)") - append("- [Index](concepts/index.html)") + append("[Concept overview](concepts/overview.html)
") + append("[Concept index](concepts/index.html)") append() - # for concept in concept_model.concepts: - # append(f"- [{concept.title}]({concept.href})") - + append() + append("
") + append("
") append() append("#### Resources") append() - append("- [Overview](resources/overview.html)") - append("- [Index](resources/index.html)") + append("[Resource overview](resources/overview.html)
") + append("[Resource index](resources/index.html)") append() - # for resource in resource_model.resources: - # append(f"- [{resource.title}]({resource.href})") - + append() + append("
") + append("
") append() append("#### Commands") append() - append("- [Overview](commands/overview.html)") - append("- [Index](commands/index.html)") + append("[Command overview](commands/overview.html)
") + append("[Command index](commands/index.html)") append() - # for command in command_model.commands: - # append(f"- [{command.title}]({command.href})") - + append() + append("
") + append("
") append() append.write("input/index.md") diff --git a/python/resources.py b/python/resources.py index f012d13..4515d13 100644 --- a/python/resources.py +++ b/python/resources.py @@ -9,6 +9,8 @@ def generate(model): append("---") append("refdog_links:") + append(" - title: Resource overview") + append(" url: overview.html") append(" - title: Skupper concepts") append(" url: /concepts/index.html") append(" - title: Skupper commands") @@ -17,8 +19,6 @@ def generate(model): append() append("# Skupper resources") append() - append("[Overview](overview.html)") - append() for group in model.groups: append(f"#### {group.title}")