Documentation wip #2
Conversation
|
|
||
| Project Link: [https://github.com/sparkgeo/terradactile-lambda/](https://github.com/sparkgeo/terradactile-lambda/) | ||
|
|
||
| Readme template edited by Alex Leamy at SparkGeo Consulting Ltd. |
There was a problem hiding this comment.
Nice work @AL-SparkGeo ! I added some comments regarding formatting and being more explicit. Mostly my preference, so do what you want with it.
README.md
Outdated
| - terradactile/terradactile - Code for the application's Lambda function. | ||
| - terradactile/template.yaml - A template that defines the application's AWS resources. **Update the environment variables for BUCKET and ALLOWED_ORIGINS.** | ||
| - terradactile/template.yaml - A template that defines the application's AWS resources. |
There was a problem hiding this comment.
This code block is a bit weird to me. Consider not putting File Contents in a code block and leave it as text. Then use to identify thatterradactile/terradactileandterradactile/template.yaml` are paths.
|
|
||
| The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code. | ||
| **Update the environment variables for BUCKET and ALLOWED_ORIGINS.** |
There was a problem hiding this comment.
Consider making this more explicit by adding a .env-example file with those in it. Or use a code block here such as:
export BUCKET=myBucket
export ALLOWED_ORIGINS=*
README.md
Outdated
|
|
||
| To use the SAM CLI, you need the following tools. | ||
|
|
||
| * SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) | ||
| * [Python 3 installed](https://www.python.org/downloads/) | ||
| * Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) | ||
|
|
||
|
|
||
| The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code. |
There was a problem hiding this comment.
Should template.yaml be terradactile/template.yaml, to be more explicit?
| ## Deployment | ||
|
|
||
| The Serverless Application Model Command Line Interface (SAM CLI) is an extension of the AWS CLI that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API. | ||
|
|
||
| To build and deploy your application for the first time, cd to the project directory and run the following in your shell: |
There was a problem hiding this comment.
What directory are you cd into? Consider adding it to the code block below to be explicit.
Updated documentation with Mike's suggestions.
|
Old readme deleted. I'll remove it from the UI repo as well. |
Updated Documentation to be more in-line with further internal doc templates that I will be working on. Please let me know what you would like changed.