From 859fabd8eba3e55ec1990a94f74a252cbdf21125 Mon Sep 17 00:00:00 2001 From: Daniel K Lyons <dlyons@nrao.edu> Date: Wed, 2 Sep 2020 15:06:01 -0600 Subject: [PATCH] Improve the README --- services/workflow/README.md | 16 ++++++++++++++++ services/workflow/README.txt | 1 - 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 services/workflow/README.md delete mode 100644 services/workflow/README.txt diff --git a/services/workflow/README.md b/services/workflow/README.md new file mode 100644 index 000000000..260ee6bb3 --- /dev/null +++ b/services/workflow/README.md @@ -0,0 +1,16 @@ +# Workflow: the Workspaces Workflow Service + +To use, first run the Alembic migrations: + + env CAPO_PROFILE=local alembic upgrade head + +Then you should be able to run this with: + + env CAPO_PROFILE=local pserve --reload development.ini + +Once there, try the following URLs: + +- http://0.0.0.0:3456/workflows +- http://0.0.0.0:3456/workflows/0 +- http://0.0.0.0:3456/workflows/0/files +- http://0.0.0.0:3456/workflows/0/files/file.txt diff --git a/services/workflow/README.txt b/services/workflow/README.txt deleted file mode 100644 index 97c634472..000000000 --- a/services/workflow/README.txt +++ /dev/null @@ -1 +0,0 @@ -# Workflow: the Workspaces Workflow Service -- GitLab