Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include developer docs #169

Open
smohiudd opened this issue Sep 9, 2024 · 2 comments
Open

Include developer docs #169

smohiudd opened this issue Sep 9, 2024 · 2 comments
Assignees
@stephenkilbourn

Comments

@smohiudd
Copy link
Collaborator

smohiudd commented Sep 9, 2024 •
edited
Loading

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
Copy link
Contributor

j08lue commented Sep 10, 2024

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.

@stephenkilbourn stephenkilbourn self-assigned this Sep 11, 2024
@stephenkilbourn stephenkilbourn mentioned this issue Sep 11, 2024
Open
@anayeaye
Copy link
Collaborator

EOEPCA+ is doing docs-driven development

❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stephenkilbourn stephenkilbourn

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@anayeaye @j08lue @stephenkilbourn @smohiudd