search

canonical / bundle-kubeflow

Charmed Kubeflow
Apache License 2.0
104 stars 50 forks source link

Repo's /script folder structure is not intuitive #1058

Open kimwnasptd opened 2 months ago

kimwnasptd commented 2 months ago

Bug Description

This was created after the discussion in https://github.com/canonical/bundle-kubeflow/pull/1038#discussion_r1738437033

Right now the /scripts folder in the repo contains

  1. a lot of different scripts and it's not clear what users should expect to find in this directory
  2. scripts that are not used from our CI

We should re-organise the structure of this directory. For example we have scripts for deploying in airgap, gathering images from a bundle, and scripts for fetching bundle versions https://github.com/canonical/bundle-kubeflow/pull/1035

To quote the PR https://github.com/canonical/bundle-kubeflow/pull/1038#discussion_r1745736189

the logical grouping of the script that gets all images + its supporting files (e.g. requirements.txt) should be placed in a path where it is obvious that it contains these sort of scripts. As a developer, I won't expect the fetch image scripts to be placed all around in scripts/ and in airgap/. The suggestion we are making is to have all the scripts and supporting files in the same directory as we strive for correctness and a more logical grouping.

To Reproduce

Navigate into the /scripts dir, w

Environment

Current main from f54e01568e80e71ddae9e5c5a011669b5d2de930

Relevant Log Output

<none>

Additional Context

The dir also doesn't contain any README

syncronize-issues-to-jira[bot] commented 2 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-6209.

This message was autogenerated