Skip to content

Commit

Permalink
Merge pull request #114 from developmentseed/docs/update-mkdocs
Browse files Browse the repository at this point in the history
Add deployment information to mkdocs, and reference eoapi-template.
  • Loading branch information
vincentsarago committed Jul 18, 2023
2 parents 749b85d + 106135c commit 965f9be
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ Note: services might have incompatible dependencies which you can resolve by usi

This repository has the demonstration runtimes that are consistently updated with new functionality.

The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [k8s-eoapi](https://github.com/developmentseed/k8s-eoapi)).
The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)).

A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template).

## Contribution & Development

Expand Down
3 changes: 2 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ nav:
- Home: "index.md"
- Intro: "intro.md"
- Services: "services.md"
- Development - Contributing: "contributing.md"
- Deployment: "deployment.md"
- Development - Contributing: "contributing.md"


plugins:
- search
Expand Down
6 changes: 5 additions & 1 deletion docs/src/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ hide:
- navigation
---

The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s)).

A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template).

## AWS (Lambda)

An example of Cloud Stack is available for AWS (RDS for the database and Lambda for the APIs)
Expand Down Expand Up @@ -84,4 +88,4 @@ If you get an error saying that the max VPC's has been reached, this means that
## K8S
A Kubernetes chart is currently being developed at https://github.com/developmentseed/k8s-eoapi
A Kubernetes chart is currently being developed at https://github.com/developmentseed/eoapi-k8s

0 comments on commit 965f9be

Please sign in to comment.