Add deployment information to mkdocs, and reference eoapi-template. #114
Conversation
Inverse deployment and contributing in headers/footers within mkdocs.yml. Add eoapi-template reference to deployment.md. Reduce content in intro.md to match previous version.
| 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)). | ||
|
|
||
| A demonstration application is accessible with the repository [eoapi-template](https://github.com/developmentseed/eoapi-template). | ||
|
|
There was a problem hiding this comment.
I think we should really explain clearly what are the option for deploying an eoAPI like system.
right now this page deployment.md is a mix of two things:
- links to external repo (eoapi-cdk and k8s-eoapi)
- a step-by-step
how toto deploy eoapi custom demo application
IMO this is really confusing.
Possible solution
- create an
eoapi-docsrepo to host all the documentation about eoapi - use the current
eaopirepo as an example of how eoapi can work
There was a problem hiding this comment.
I just renamed the repo to eoapi-k8s so that will have to change too
There was a problem hiding this comment.
@vincentsarago We can also just remove the external references if you prefer, but I thought it would be helpful for someone interested in deployment to have this information readily available.
There was a problem hiding this comment.
@ranchodeluxe updated the name references to the repo.
There was a problem hiding this comment.
@vincentsarago I agree this is confusing. Ideally I think the eoAPI repo would have 3 deployment sections
- How to deploy the eoAPI demonstration runtimes locally via docker.
- A description of
eoapi-cdk,eoapi-cdkandeoapi-templateand pointers to their docs for deploying with the default runtimes they contain. - How to deploy the eoAPI demonstration runtimes using a local CDK app (mostly copy and pasted from
eoapi-template) that uses theeoapi-cdkconstructs but with runtime overrides.
I think this is what @zacharyDez was shooting for with his PR but based on your feedback maybe we need a bit more clarification.
There was a problem hiding this comment.
@sharkinsspatial yep that's it on point!
There was a problem hiding this comment.
Got it! Will go for another iteration.
Closes #113
Based on @sharkinsspatial recommendations: