search

microsoft / Data-Appliance-GX

Sovereign Data Sharing Appliance/Connector for enterprise scenarios
MIT License
8 stars 7 forks source link

folder naming #81

Open MoritzKeppler opened 3 years ago

MoritzKeppler commented 3 years ago

just some minor observations we stumbled upon while reading in:

"terraform" refers to a technology and does also contain helm charts (in some cases, e.g. on premises, just helm charts may be used). What about rename it to "scripts"? (naming inspired by https://github.com/golang-standards/project-layout)

Expected to find code under "components" but it was (quite useful!) documentation. Maybe better name it "docs"?

"integration" contains tests, so why not call it just "tests"?

paullatzelsperger commented 3 years ago

ad terraform: fine with me. ad components: strictly speaking there is in fact code there, check at components/deploy-gaiax-data-components/sample-code, but I know what you mean :) ad integration: that stuff is mostly used as local debug harness, not so much as i-tests. In fact, all tests are disabled (or should be at least)

jimmarino commented 3 years ago

+1 on renaming the terraform directory.

The components was just a place I had the internal MSFT team make as a temporary location to place their work that was in an internal repo. We couldn't think of a name for it, so I just said "components".

Ideally, I'd like to start taking stuff out of there and creating more formalized places for where it makes sense to put them. For example, I think we should think about having K8S operators for some of the subsystems, e.g. NiFi. I'm not sure if it is best to have separate repos for those things (for example, an operator may be written in Go). Perhaps we can start the discussion about what that would entail and see what people's opinions and ideas are?