Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Jan 2, 2025
1 parent a1864e5 commit b69a0be
Show file tree
Hide file tree
Showing 11 changed files with 63 additions and 42 deletions.
4 changes: 2 additions & 2 deletions input/commands/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
refdog_links:
- title: Command overview
url: overview.html
- title: Skupper concepts
url: /concepts/index.html
- title: Skupper resources
Expand All @@ -8,8 +10,6 @@ refdog_links:

# Skupper commands

[Overview](overview.html)

#### Site operations

<table class="objects">
Expand Down
12 changes: 7 additions & 5 deletions input/commands/overview.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions input/concepts/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
refdog_links:
- title: Concept overview
url: overview.html
- title: Skupper resources
url: /resources/index.html
- title: Skupper commands
Expand All @@ -8,8 +10,6 @@ refdog_links:

# Skupper concepts

[Overview](overview.html)

#### Sites

<table class="objects">
Expand Down
6 changes: 4 additions & 2 deletions input/concepts/overview.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
24 changes: 18 additions & 6 deletions input/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,32 @@ body_class: object index

# Refdog

<div style="display: flex;">
<div style="margin-right: 4em;">

#### Concepts

- [Overview](concepts/overview.html)
- [Index](concepts/index.html)
[Concept overview](concepts/overview.html)<br/>
[Concept index](concepts/index.html)


</div>
<div style="margin-right: 4em;">

#### Resources

- [Overview](resources/overview.html)
- [Index](resources/index.html)
[Resource overview](resources/overview.html)<br/>
[Resource index](resources/index.html)


</div>
<div style="margin-right: 4em;">

#### Commands

- [Overview](commands/overview.html)
- [Index](commands/index.html)
[Command overview](commands/overview.html)<br/>
[Command index](commands/index.html)


</div>
</div>
4 changes: 2 additions & 2 deletions input/resources/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
refdog_links:
- title: Resource overview
url: overview.html
- title: Skupper concepts
url: /concepts/index.html
- title: Skupper commands
Expand All @@ -8,8 +10,6 @@ refdog_links:

# Skupper resources

[Overview](overview.html)

#### Primary resources

<table class="objects">
Expand Down
6 changes: 4 additions & 2 deletions input/resources/overview.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 2 additions & 2 deletions python/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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}")
Expand Down
4 changes: 2 additions & 2 deletions python/concepts.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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}")
Expand Down
33 changes: 18 additions & 15 deletions python/generate.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,39 @@ def generate_index():
append()
append("# Refdog")
append()
append("<div style=\"display: flex;\">")
append("<div style=\"margin-right: 4em;\">")
append()
append("#### Concepts")
append()

append("- [Overview](concepts/overview.html)")
append("- [Index](concepts/index.html)")
append("[Concept overview](concepts/overview.html)<br/>")
append("[Concept index](concepts/index.html)")
append()

# for concept in concept_model.concepts:
# append(f"- [{concept.title}]({concept.href})")

append()
append("</div>")
append("<div style=\"margin-right: 4em;\">")
append()
append("#### Resources")
append()
append("- [Overview](resources/overview.html)")
append("- [Index](resources/index.html)")
append("[Resource overview](resources/overview.html)<br/>")
append("[Resource index](resources/index.html)")
append()

# for resource in resource_model.resources:
# append(f"- [{resource.title}]({resource.href})")

append()
append("</div>")
append("<div style=\"margin-right: 4em;\">")
append()
append("#### Commands")
append()
append("- [Overview](commands/overview.html)")
append("- [Index](commands/index.html)")
append("[Command overview](commands/overview.html)<br/>")
append("[Command index](commands/index.html)")
append()

# for command in command_model.commands:
# append(f"- [{command.title}]({command.href})")

append()
append("</div>")
append("</div>")
append()

append.write("input/index.md")
4 changes: 2 additions & 2 deletions python/resources.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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}")
Expand Down

0 comments on commit b69a0be

Please sign in to comment.