Include developer docs - Githubissues

NASA-IMPACT / veda-docs

Documentation for the VEDA Project

https://nasa-impact.github.io/veda-docs

Apache License 2.0

7 stars 7 forks source link

Include developer docs #169

Closed smohiudd closed 1 week ago

smohiudd commented 2 months ago

Description

As outlined in https://github.com/NASA-IMPACT/veda-architecture/issues/459, we will include developer documentation in veda-docs which is aimed at developers who want to deploy and maintain a VEDA platform - what we're calling platform users.

The platform documentation will include the following:

backend services (data access and ingestion) architecture
choice of standards
how to deploy VEDA
recommendation for maintainers

j08lue commented 2 months ago

Btw, EOEPCA+ docs are perhaps a good reference for how to document an open source service architecture https://eoepca.readthedocs.io/projects/architecture/en/latest/

Please note that EOEPCA+ is doing docs-driven development - so some of the docs are ahead of the actual development and they are also WIP.

anayeaye commented 2 months ago

EOEPCA+ is doing docs-driven development

❤️

j08lue commented 1 week ago

Closed in https://github.com/NASA-IMPACT/veda-docs/pull/170