My opinions:

Utility modules

These live in multiple places currently:

common/
gui/src/dashboard/utilities/
gui/src/project-view/util/

I think most of these should be moved into gui/, ideally under neither dashboard nor project-view (open for discussion though!)

Feature slices

I think (at least for the dashboard) the codebase could be split based on the general feature, rather than simply "project view" vs "dashboard".

Note

The purpose of this move would be to more clearly split the codebase, to discourage the idea of "working on the dashboard"

In particular, the dashboard can be split into:

Authentication pages
Data Catalog
Settings pages

There are smaller sub-tasks that would fall under this task as well, such as moving modals, providers, services etc. to their appropriate 'slice'.

Example moves (up for discussion):

gui/src/dashboard/pages/authentication/ -> gui/src/authentication/
gui/src/dashboard/layouts/Settings/ -> gui/src/settings/
gui/src/dashboard/pages/dashboard/ -> gui/src/data-catalog/
gui/src/dashboard/components/ -> gui/src/react-components/ (optional!)

Nested directories

This one may only be a problem in the Dashboard codebase - some files are quite deeply nested, we should just consider whether the directory structure can be flattened. Personally, I guess it would be nice to optimize for discoverability - which means avoiding nesting files inside more directories for the sake of consistency, but also not putting too many files in a single directory (e.g. 50+) unless they cannot be grouped further

Note

These suggestions (intentionally) consist mostly of moving code around, so they should - on paper - be relatively low hanging fruit.

IDE Codebase structure #13217

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions