docs: update readme files

Author: jacobtread

README.md

@@ -0,0 +1,6 @@
+# Docbox Serverless AWS
+
+This is a serverless variant of [Docbox](https://github.com/docbox-nz/docbox) designed to run as a
+collection of lambdas rather than a persistent server.
+
+> This is currently a work-in-progress implementation

cspell.json

@@ -10,6 +10,9 @@
     "dotenv",
     "onlyoffice",
     "dtolnay",
-    "poppler"
+    "poppler",
+    "jacobtread",
+    "loker",
+    "TYPESENSE"
   ]
 }

lambdas/http/README.md

@@ -1,6 +1,6 @@
-# Introduction
+# Docbox HTTP Lambda
 
-http is a Rust project that implements an AWS Lambda function in Rust.
+This lambda is responsible for providing the HTTP API for Docbox
 
 ## Prerequisites
 
@@ -12,46 +12,3 @@ http is a Rust project that implements an AWS Lambda function in Rust.
 To build the project for production, run `cargo lambda build --release`. Remove the `--release` flag to build for development.
 
 Read more about building your lambda function in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/build.html).
-
-## Testing
-
-You can run regular Rust unit tests with `cargo test`.
-
-If you want to run integration tests locally, you can use the `cargo lambda watch` and `cargo lambda invoke` commands to do it.
-
-First, run `cargo lambda watch` to start a local server. When you make changes to the code, the server will automatically restart.
-
-Second, you'll need a way to pass the event data to the lambda function.
-
-You can use the existent [event payloads](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-events/src/fixtures) in the Rust Runtime repository if your lambda function is using one of the supported event types.
-
-You can use those examples directly with the `--data-example` flag, where the value is the name of the file in the [lambda-events](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-events/src/fixtures) repository without the `example_` prefix and the `.json` extension.
-
-```bash
-cargo lambda invoke --data-example apigw-request
-```
-
-For generic events, where you define the event data structure, you can create a JSON file with the data you want to test with. For example:
-
-```json
-{
-    "command": "test"
-}
-```
-
-Then, run `cargo lambda invoke --data-file ./data.json` to invoke the function with the data in `data.json`.
-
-For HTTP events, you can also call the function directly with cURL or any other HTTP client. For example:
-
-```bash
-curl https://localhost:9000
-```
-
-Read more about running the local server in [the Cargo Lambda documentation for the `watch` command](https://www.cargo-lambda.info/commands/watch.html).
-Read more about invoking the function in [the Cargo Lambda documentation for the `invoke` command](https://www.cargo-lambda.info/commands/invoke.html).
-
-## Deploying
-
-To deploy the project, run `cargo lambda deploy`. This will create an IAM role and a Lambda function in your AWS account.
-
-Read more about deploying your lambda function in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/deploy.html).

lambdas/presigned-cleanup/README.md

@@ -1,8 +1,14 @@
-# Introduction
+# Docbox Presigned Cleanup Lambda
 
 presigned-cleanup is a background task to perform cleanup and deletion of
 expired presigned file upload resource
 
+This should be connected like so:
+
+Amazon Event Bridge Trigger ("rate(1 hour)") -> Docbox Presigned Cleanup Lambda
+
+> Adjust schedule to you're desired cleanup rate.
+
 ## Prerequisites
 
 - [Rust](https://www.rust-lang.org/tools/install)
@@ -13,40 +19,3 @@ expired presigned file upload resource
 To build the project for production, run `cargo lambda build --release`. Remove the `--release` flag to build for development.
 
 Read more about building your lambda function in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/build.html).
-
-## Testing
-
-You can run regular Rust unit tests with `cargo test`.
-
-If you want to run integration tests locally, you can use the `cargo lambda watch` and `cargo lambda invoke` commands to do it.
-
-First, run `cargo lambda watch` to start a local server. When you make changes to the code, the server will automatically restart.
-
-Second, you'll need a way to pass the event data to the lambda function.
-
-You can use the existent [event payloads](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-events/src/fixtures) in the Rust Runtime repository if your lambda function is using one of the supported event types.
-
-You can use those examples directly with the `--data-example` flag, where the value is the name of the file in the [lambda-events](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-events/src/fixtures) repository without the `example_` prefix and the `.json` extension.
-
-```bash
-cargo lambda invoke --data-example apigw-request
-```
-
-For generic events, where you define the event data structure, you can create a JSON file with the data you want to test with. For example:
-
-```json
-{
-    "command": "test"
-}
-```
-
-Then, run `cargo lambda invoke --data-file ./data.json` to invoke the function with the data in `data.json`.
-
-Read more about running the local server in [the Cargo Lambda documentation for the `watch` command](https://www.cargo-lambda.info/commands/watch.html).
-Read more about invoking the function in [the Cargo Lambda documentation for the `invoke` command](https://www.cargo-lambda.info/commands/invoke.html).
-
-## Deploying
-
-To deploy the project, run `cargo lambda deploy`. This will create an IAM role and a Lambda function in your AWS account.
-
-Read more about deploying your lambda function in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/deploy.html).

lambdas/upload-completion/README.md

@@ -1,8 +1,12 @@
-# Introduction
+# Docbox Upload Completion Lambda
 
 upload-completion is a handler for file upload completions to S3 to handle
 finishing presigned file uploads
 
+This should be connected like so:
+
+S3 Object Created Event -> SQS -> Docbox Upload Completion Lambda
+
 ## Prerequisites
 
 - [Rust](https://www.rust-lang.org/tools/install)
@@ -13,40 +17,3 @@ finishing presigned file uploads
 To build the project for production, run `cargo lambda build --release`. Remove the `--release` flag to build for development.
 
 Read more about building your lambda function in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/build.html).
-
-## Testing
-
-You can run regular Rust unit tests with `cargo test`.
-
-If you want to run integration tests locally, you can use the `cargo lambda watch` and `cargo lambda invoke` commands to do it.
-
-First, run `cargo lambda watch` to start a local server. When you make changes to the code, the server will automatically restart.
-
-Second, you'll need a way to pass the event data to the lambda function.
-
-You can use the existent [event payloads](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-events/src/fixtures) in the Rust Runtime repository if your lambda function is using one of the supported event types.
-
-You can use those examples directly with the `--data-example` flag, where the value is the name of the file in the [lambda-events](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-events/src/fixtures) repository without the `example_` prefix and the `.json` extension.
-
-```bash
-cargo lambda invoke --data-example apigw-request
-```
-
-For generic events, where you define the event data structure, you can create a JSON file with the data you want to test with. For example:
-
-```json
-{
-    "command": "test"
-}
-```
-
-Then, run `cargo lambda invoke --data-file ./data.json` to invoke the function with the data in `data.json`.
-
-Read more about running the local server in [the Cargo Lambda documentation for the `watch` command](https://www.cargo-lambda.info/commands/watch.html).
-Read more about invoking the function in [the Cargo Lambda documentation for the `invoke` command](https://www.cargo-lambda.info/commands/invoke.html).
-
-## Deploying
-
-To deploy the project, run `cargo lambda deploy`. This will create an IAM role and a Lambda function in your AWS account.
-
-Read more about deploying your lambda function in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/deploy.html).