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

folder naming #81

Open
MoritzKeppler opened this issue May 21, 2021 · 2 comments
Open

folder naming #81

MoritzKeppler opened this issue May 21, 2021 · 2 comments

Comments

@MoritzKeppler
Copy link
Collaborator

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

paullatzelsperger commented May 21, 2021

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

jimmarino commented May 22, 2021

+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?

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

3 participants