Skip to content

Commit

Permalink
Update the readme, plus some tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Jan 16, 2024
1 parent b3aefd9 commit 4081385
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,9 @@ commands:
generate Generate README.md from the data in skewer.yaml
render Render README.html from the data in skewer.yaml
clean Clean up the source tree
run Run the example steps using Minikube
run-external Run the example steps with user-provided kubeconfigs
demo Run the example steps and pause before cleaning up
test Test README generation and run the steps on Minikube
run Run the example steps
demo Run the example steps and pause for a demo before cleaning up
test Test README generation and run the steps
update-skewer Update the embedded Skewer repo and GitHub workflow
~~~

Expand All @@ -92,7 +91,7 @@ The top level:
~~~ yaml
title: # Your example's title (required)
subtitle: # Your chosen subtitle (required)
github_actions_url: # The URL of your workflow (optional)
workflow: # The filename of your GitHub workflow (optional, default 'main.yaml')
overview: # Text introducing your example (optional)
prerequisites: # Text describing prerequisites (optional, has default text)
sites: # A map of named sites (see below)
Expand Down Expand Up @@ -200,7 +199,6 @@ steps:
- standard: check_the_status_of_your_namespaces
- standard: link_your_namespaces
<your-custom-steps>
- standard: test_the_application
- standard: accessing_the_web_console
- standard: cleaning_up
~~~
Expand Down
6 changes: 4 additions & 2 deletions python/skewer/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ def run_steps(skewer_file, kubeconfigs=[], debug=False):

check_environment()

make_dir("/tmp/skewer", quiet=True)

model = Model(skewer_file, kubeconfigs)
model.check()

Expand Down Expand Up @@ -165,7 +167,6 @@ def run_step(model, step, check=True):
await_console_ok()

if command.run:
make_dir("/tmp/skewer", quiet=True)
run(command.run.replace("~", "/tmp/skewer"), shell=True, check=check)

def pause_for_demo(model):
Expand Down Expand Up @@ -287,7 +288,7 @@ def step_heading(step):
out.append(f"#### {model.subtitle}")
out.append("")

out.append(standard_text["example_suite_para"].strip())
out.append(standard_text["example_suite"].strip())
out.append("")
out.append("#### Contents")
out.append("")
Expand Down Expand Up @@ -647,6 +648,7 @@ def __enter__(self):
check_program("minikube")

make_dir("/tmp/skewer", quiet=True)

run("minikube -p skewer start --auto-update-drivers false")

tunnel_output_file = open("/tmp/skewer/minikube-tunnel-output", "w")
Expand Down
2 changes: 1 addition & 1 deletion python/skewer/standardtext.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
example_suite_para: |
example_suite: |
This example is part of a [suite of examples][examples] showing the
different ways you can use [Skupper][website] to connect services
across cloud providers, data centers, and edge sites.
Expand Down

0 comments on commit 4081385

Please sign in to comment.