MetaCell / cloud-harness

Other
14 stars 5 forks source link

Add dev specific doc for CloudHarness CLI tools #711

Closed aranega closed 5 months ago

aranega commented 8 months ago

This PR proposes a documentation for CloudHarness developers, to help to locate and understand how the different part of the projects are working together.

The CloudHarness code base can be really complicated to understand well in the first place, there is a lot of sub-projects and libraries. This documentation aims developers to help them navigate through the source code and understand some concepts in order to be able to fix bugs or extend the various tools present in CloudHarness to implement new features quickly.

Sanity checks:

Breaking changes (select one):

Possible deployment updates issues (select one):

Test coverage (select one):

Documentation (select one):

Nice to have (if relevant):

filippomc commented 6 months ago

Hey @aranega I see this is still in draft, worth merging in your opinion?

aranega commented 6 months ago

@filippomc I think it's OK, but you should take a look to see if I'm not saying something wrong inside. I don't think it's finished yet, but at the same time, it's something that we can improve with time.