Add proposed directories layout

[ScorpioCPH]

@jlewi @gaocegege @zjj2wry @wackxu @DjangoPeng This PR proposed new directories layout as shown below:

$ tree -d -I 'vendor|bin|.git'
├── build
│   ├── images
│   └── release
├── cmd
│   └── tf_operator
├── dashboard
│   ├── backend
│   └── frontend
├── docs
│   └── diagrams
├── examples
│   ├── charts
│   ├── gke
│   ├── tensorflow-models
│   ├── tf_job
│   └── tf_sample
├── hack
│   └── py
├── pkg
│   ├── apis
│   │   └── tensorflow
│   ├── client
│   ├── controller
│   └── util
├── test
│   ├── e2e
│   └── test-infra
└── version

PTAL and leave your comments about this change, and after discussion i will send a PR to do this directories refactor. Thanks!

---

This change is 

[k8s-ci-robot]

Hi @ScorpioCPH. Thanks for your PR.

I'm waiting for a kubernetes or tensorflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[coveralls]

Coverage increased (+0.08%) to 28.601% when pulling 0dcf6e6 on ScorpioCPH:proposed-dic-layout into ed7cae7 on tensorflow:master.

[zjj2wry]

/ok-to-test

[zjj2wry]

mv version to pkg would be better.

[jlewi]

Why is py under hack? It contains a bunch of scripts that are critical to our test infrastructure.
I think my preference would be to put all of our python scripts under py and start organizing it into packages
e.g.
py
tfk8s
testing
....
hack

So that one could do

import tfk8s.testing
import  tfk8s.hack

I don't think the tf-job-operator chart belongs under examples; its not an example its the actual way we recommend deploying the tf-job-operator (although I want to switch to ksonnet).

Does it make more sense to leave the charts directory and move it into that?

[ScorpioCPH]

@jlewi Hi, I follow up Kubernetes style :)

It contains a bunch of scripts that are critical to our test infrastructure.

How about put py into test?

its not an example its the actual way we recommend deploying the tf-job-operator.

Move them into build/release?

[jlewi]

Sorry for the delay

How about put py into test?

Can we leave the py directory as is for now?

The modules aren't necessarily test specific so they might not belong in testing. For example, there's a very crude python client library for working with tfjobs. This is useful outside of testing; e.g. for managing TfJobs from Jupyter notebooks. So eventually we might want to turn this into a pip package that we officially release maintain.

So I think the direction we are headed is organizing all py code under "/py" such that anything in "py" is a top level package.

its not an example its the actual way we recommend deploying the tf-job-operator.
Move them into build/release?

./tf-job-operator-chart isn't the actual release artifact. The released artifact is the result of substituting in values to pin things like images to a particular release. So I don't know that it makes sense to put in build/release.

That said; I'd like to get rid of the helm packages in favor of ksonnet (#239). So I'd suggest leaving it where is for now since we'll eventually delete it so moving it is just churn.

[jlewi]

I'd also be ok with putting the tf-job-operator chart under hack or /legacy or /deprecated to indicate its something we want to get rid of.

[gaocegege]

The python code is uncoupled with the go code so could we place the python code into another repo?

[ScorpioCPH]

So I think the direction we are headed is organizing all py code under "/py" such that anything in "py" is a top level package.

I'd also be ok with putting the tf-job-operator chart under hack or /legacy or /deprecated to indicate its something we want to get rid of.

LGTM :)

[jlewi]

What is in the images directory? Dockerfiles for images?

[ScorpioCPH]

Yes.

[jlewi]

Per discussion please make py toplevel directory.

[ScorpioCPH]

Sure.

[jlewi]

per conversation tf-job-operator-chart should not be under examples.

[ScorpioCPH]

LGTM.

[coveralls]

Coverage increased (+0.08%) to 28.458% when pulling b104cf9 on ScorpioCPH:proposed-dic-layout into f7803f1 on tensorflow:master.

[jlewi]

Approved