Skip to content
This repository has been archived by the owner on Oct 17, 2018. It is now read-only.

Delete dead code and add basic documentation for what is actually used #78

Open
jaseemabid opened this issue Mar 26, 2018 · 1 comment

Comments

@jaseemabid
Copy link
Contributor

jaseemabid commented Mar 26, 2018

There is a just a lot of configuration files in this repository that makes it very hard for anyone new to understand what is going on. Adding some basic docs (like apps vs packages, what is being deployed etc) will also help.

A few things I can think of are,

  1. How are the yaml files applied? Are all of them used? Where is the code for it?
  2. What is apps vs packages?
  3. What is the pom.xml, release.groovy and jenkins file really doing there? Are we shipping all the files as a maven package and then downloading it back to osio while being deployed?
  4. Can we remove all the maven bits from here? Is it really necessary?
  5. Is apps/jenkins-test used at all?

cc: @aslakknutsen

@jaseemabid jaseemabid changed the title Delete dead code Delete dead code and add basic documentation for what is actually used Mar 26, 2018
@aslakknutsen
Copy link

  1. No, we primarly use apps/jenkins apps/contentrepo apps/bayesian-link packages/fabric8-tenant-jenkins fabric8-tenant-jenkins-quotas-oso as far as OSiO is concerned.

  2. A package contain multiple Apps. A Package is a 'software collection' if you will. A distribution package. A way to bundle Apps. etc etc

  3. The whole thing is 'compiled' by the fmp into a template set per package, pushed to Maven Central and consumed by Tenant service on provisoning. So yes.

  4. Debatable. It's required in the current form.

  5. It was intended to be used when running the BDD tests. Unsure about the state of those.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants