Skip to content

Commit

Permalink
Update Documentation According to Feedback (#330)
Browse files Browse the repository at this point in the history
* Add workflow ID to Quick Start

* Add prerequisite comment

* Delete TEARDOWN.md
  • Loading branch information
vGsteiger authored Dec 28, 2024
1 parent ab362aa commit 0e6a07a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
12 changes: 12 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,18 @@ If you opened a shell, you can run all the caribou commands without the `poetry
caribou --help
```

### Ensure the poetry environment is running Python 3.12+

Poetry will ensure that you are using Python 3.12 or higher based on the configuration in the `pyproject.toml` file. If you do not have the correct Python version, Poetry will notify you and you will need to install Python 3.12 or higher.

To verify your Python version manually, you can use:

```bash
python --version
```

If your version is lower than 3.12, follow the instructions for your operating system to install Python 3.12 or higher.

## AWS Account Access

To run the framework, you need an AWS account and the necessary permissions to create and manage the required resources.
Expand Down
6 changes: 6 additions & 0 deletions QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ Where `<workflow_name>` is the name of the new workflow.

You can then use the Caribou Python API to define and develop the workflow.

### Workflow ID

When a new workflow is set up, it is initialized with the semantic version `0.0.1` as configured in the config and `app.py` workflow initialization.
This, together with the `<workflow_name>`, will constitute the workflow ID (`<workflow_name>-<version_number>`).
A workflow ID is unique in the Caribou middleware component, meaning if an ID is already deployed ([Deployment Utility](#deployment-utility)) it cannot be deployed again unless it is deleted ([Remove a workflow](#remove-a-workflow)).

### Example Workflow

In the `examples/small_sync_example` directory, you can find an example workflow that you can use to get started.
Expand Down

0 comments on commit 0e6a07a

Please sign in to comment.