A Layout of the JupyterHub repository

[Temidayo32]

@choldgraf raised an issue #3080 on the need for a documentation that provides a layout of the Jupyterhub repository. This pull request addresses the issue. Please, let me know of any further corrections to the made.

I am also an Outreachy intern. This effectively serves as my first contribution to the project during this contribution period.

[minrk]

Thanks @Temidayo32, I think this is useful!

I think when I mentioned a layout of the repo in jupyterhub/team-compass#296 (comment) I was referring to how the code (within jupyterhub/ is organized (e.g. orm.py contains the database code, the REST API is in jupyterhub/apihandlers, etc.), but this is still useful.

@choldgraf @willingc what do you think is the right level of detail to describe "all the files" of a single repo? I don't see this very often in repo docs.

[minrk]

dotfiles aren't a separate category - these are mostly the same as what's called 'executable files' right now. Some of them just happen to start with '.'

[manics]

I think the main thing to consider is whether this will be kept up to date. @willingc suggested a top-level LAYOUT file which has the advantage it's more visible to anyone modifying the code.

If we keep it as RST then how about hyperlinking the files docs to the main branch, so if anything moves in future we can use a linkchecker to detect a broken link?

[Temidayo32]

@manics Yeah, that is a good observation. I would think if kept high level enough, then updating needs would be minimal. The documentation would go through a major revamp on the completion of the Outreachy intern. This could mean a major modification of the files in the docs directory. However, if the layout is kept just describing the docs folder and not going indepth to describe its sub-folder, then the modification that would take place would not require an updating of the Layout