Skip to content

Commit

Permalink
Remove specific location of data files
Browse files Browse the repository at this point in the history
In Keith's absence and to get this RFC over the line I have updated the
RFC to reflect that the data files if they exist should be co-located,
but the exact location is yet to be determined.
  • Loading branch information
leenagupte committed Aug 23, 2024
1 parent ef176e2 commit 1740c6e
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions rfc-175-frontend-fewer-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,7 @@ The host app will follow the default MVC structure of Rails applications, with s
│ ├── presenters
│ ├── views
├── config
│ ├── data
│ ├── locales
├── data
├── lib
│ ├── tasks
└── .gitignore
Expand All @@ -147,15 +145,11 @@ Use `lib` rather than `app/lib` for custom code that enhances the app but doesn

Under `/config`

`data`
- YAML, JSON, CSV config files. Data files should be placed here if they are clearly used in the configuration of the app. Ideally, though, we should **avoid using data files** for configuration where possible (see `/data` below)

`locales`
- Static content like lists of contact information should ideally be stored in the locale files to promote localisation.

Under `/data`

- YAML, JSON, CSV files used as data by Models. However, note that ideally we should **avoid using data files** - where possible, all information required for rendering should come from the content item or other APIs or be a static part of the app.
We should **avoid using data files** - where possible, all information required for rendering should come from the content item or other APIs or be a static part of the app. For that reason they have been left out of the directory structure. However, if data files are required in the future they should co-located.


Namespaces will be used to group functionality e.g. for StepBySteps, and resources in the routes file. This structure will be documented in README of the host app.
Expand Down

0 comments on commit 1740c6e

Please sign in to comment.