Skip to content

local-env: submit a folder structure reorganization proposal

Created by: jhchabran

See RFC 497 and this first draft.

Non-Goal: reorganizing the code struture. We only focus on the surroundings.

Summary: The way our repository is structured is problematic on multiple levels. The result is that it's hard to find what you're looking for unless you have been previously exposed to it.

Ignoring the code structure and focusing on the surrounding folders we can see the following problems (non exhaustive)

  • dev/ is really complex and the nested folders are not helping. Understanding where a given script is and why it's there is a chore.
  • components that are necessary to run locally, Grafana for example have their configuration scattered across the structure.
  • tests that aren't tied to an existing codebase are nested under dev/ which is confusing.

To put it in a different way, the dev folder is a catch-all for anything that doesn't have a clear folder to live within.

Plan:

  1. List all the problems with the existing folder structure
  2. Create a miro board so everyone can explore and react on the proposed solution.
  3. Slice the transition in small increments that won't mess with all the scripts at once.
  4. Assuming we get enough buy-ins, execute the iterations.