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.

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

Add basic architecture documentation #12

Closed
3 of 4 tasks
j08lue opened this issue Jun 25, 2024 · 1 comment
Closed
3 of 4 tasks

Add basic architecture documentation #12

j08lue opened this issue Jun 25, 2024 · 1 comment
Assignees

Comments

@j08lue
Copy link
Collaborator

j08lue commented Jun 25, 2024

All building blocks need docs based off of this template: https://github.com/EOEPCA/document-template and chained together into the main docs site via https://github.com/EOEPCA/docroot

Following up on

Document:

  1. Why have we chosen this architecture?
  2. Strengths and differences of the libraries
  3. Benefits of making both libraries available in the building block
  4. Pattern of integration

Acceptance criteria

  • Decide on whether we'll have a dedicated repo for the Data Access BB helm charts
  • Bootstrap Data Access BB docs in dedicated docs repo or helm charts repo
  • @j08lue to start document / docs branch
  • @constantinius to contribute
@j08lue j08lue self-assigned this Jun 25, 2024
@j08lue
Copy link
Collaborator Author

j08lue commented Jun 25, 2024

Made a first push here:

I just merged right away to start populating the docs, but it needs further revision and contribution. I'll organize that shortly.

This was referenced Jun 25, 2024
@j08lue j08lue modified the milestone: Q1 Aug 5, 2024
@j08lue j08lue closed this as completed Aug 5, 2024
@j08lue j08lue added this to the Q1 milestone Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant