Repository Organizational Suggestions

[vsoch]

• Main README: under the title explain the repository includes code and data for experiments published in X. Have an explicit link to each directory with a description of what is found inside. The current content is great - I'd move into an Experimental Summary section there.
• What is .idea and should it be removed?
• I cd'd into https://github.com/rajibhossen/flux-k8s-scaler/tree/main/cluster-autoscaler and there are two issues: 1. I have no clue what context this is relevant for in terms of experiments. And 2. It's talking about files (the eks configs) that aren't here.
• Ditto for https://github.com/rajibhossen/flux-k8s-scaler/tree/main/custom-metrics-setup

OK I think I'm going to stop - here is what we can do. Start with the organization described above in the main README. Then one at a time, walk through the instructions you are providing to the used in the subdirectory README. Every file should be there. Instead of having README-.md (that is hard to read) have a structure for an experiment directory that looks like the following:

experiment-name
   strategy
       applicationA
           README.md
       applicationB/
           README.md

Every file should be scoped to exactly where it was used, and anything mentioned in the README should be there. If you need to copy files (and have redundancy) that's fine. For example, when you said you manually changed values in an eksctl config? Actually create each of those files for the reader.

We will likely need a few rounds of changes.

[rajibhossen]

Further reorganization suggestions by @vsoch

setup/
   cluster-autoscaler/
   custom-metrics/
experimentA/
   ....
experimentA/
    strategy/
      applicationA/
        README.md
      applicationB/
        README.md

With scaling by kubescaler.

setup/
  cluster-autoscaler/
  custom-metrics/
experiments/
  scaling/
    cluster-creation/
    cluster-deletion/
  auto-scaling/
    experiment-name/
       strategy/
         appA/
         appB/

In the readme.

# Name of Experiment

Summary of experiment

1. Cluster Creation

eksctl command stuff

2. Setup Autoscaler

You'll need to setup the autoscaler, which is this thing (bla bla). See [the instructions here](../../../setup) for how to do that.