Separate directory for projects?

[marcverhagen]

Because

Now all project directories are at the top-level. This implies, and this is also reflected in the readme file, that all top-level directories in the repository are considered to be project directories (with the exception of the batches directory). There are some drawbacks to this:

• If we add a directory that is not a project directory then we need to document this
• Scripts that are looking for project directories have to rely on some heuristics like "is there a process.py file" or is there a "golds" directory, which are a bit fragile.
• Once we get a lot more projects then the top-level directory gets to be quite crowded and navigation will get harder.

If there are no major repercussions for existing scripts then I would like to add a "projects" directory.

Done when

No response

Additional context

No response

[keighrim]

I thought the current structure was well-thought and well-discussed in #2, then well-documented via #37, and I have a number of scaffolding scripts that relies on the structure, so please bear with my reluctance for the proposed reform.

If we add a directory that is not a project directory then we need to document this

I don't see any necessity for this to happen for now, do you have any specific items in mind?

Scripts that are looking for project directories have to rely on some heuristics like "is there a process.py file" or is there a "golds" directory, which are a bit fragile.

scripts looking for projects just iterate the directories while just ignoring batches. That seems pretty clear from the root-level readme.

Once we get a lot more projects then the top-level directory gets to be quite crowded and navigation will get harder. ... I would like to add a "projects" directory.

I don't think adding just one level of projects directory will solve navigation problems with a lot more projects in the future. If we reach that point, I think what we need is more structured, taxonomic organization of projects.

[keighrim]

If we add a directory that is not a project directory

One obvious and expected case of this that came out during our meeting yesterday was docs directory we regularly use for other clams codebase for holding public websites. So until we decide how to address #17 , we'll keep this issue open and see.

[keighrim]

fixed via #126