Skip to content

Commit

Permalink
docs: doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jjleng committed Apr 29, 2024
1 parent b188849 commit 5644019
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 29 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,19 +99,14 @@ paka cluster down -f cluster.yaml
```

## Contributing
- code changes
- `make check-all`
- Open a PR
- Format and lint code with `make lint`
- Run tests with `make test`

## Dependencies
- docker daemon
- pulumi cli (https://www.pulumi.com/docs/install/)
- aws cli and credentials for the AWS deployment
- docker daemon and CLI
- credentials for the AWS cloud
```bash
# Make sure aws credentials and cli are set up. Your aws credentials should have access to the following services:
# - S3
# - ECR
# - EKS
# - EC2
aws configure
# Ensure your AWS credentials are correctly configured. Execute the command below and verify that the keys `aws_access_key_id` and `aws_secret_access_key` are present.
cat ~/.aws/credentials
```
11 changes: 2 additions & 9 deletions examples/invoice_extraction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,8 @@ Follow the steps below to run the example:
```bash
pip install paka

# Ensure AWS credentials and CLI are set up. Your AWS credentials should have access to the following services:
# - S3
# - ECR
# - EKS
# - EC2
aws configure

# Install pulumi CLI and verify it is working (https://www.pulumi.com/docs/install/)
pulumi version
cat ~/.aws/credentials
# Make sure you have the following keys aws_access_key_id and aws_secret_access_key
```

2. **Ensure the Docker daemon is running:**
Expand Down
11 changes: 2 additions & 9 deletions examples/website_rag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,8 @@ To run the example, first install the necessary dependencies:
```bash
pip install paka

# Make sure aws credentials and cli are set up. Your aws credentials should have access to the following services:
# - S3
# - ECR
# - EKS
# - EC2
aws configure

# Install pulumi CLI and verify it is working (https://www.pulumi.com/docs/install/)
pulumi version
# Ensure your AWS credentials are correctly configured. Execute the command below and verify that the keys `aws_access_key_id` and `aws_secret_access_key` are present.
cat ~/.aws/credentials
```

### Make sure docker daemon is running
Expand Down

0 comments on commit 5644019

Please sign in to comment.