Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples in profiles get in the way #15

Open
DrRataplan opened this issue Aug 21, 2024 · 0 comments
Open

Examples in profiles get in the way #15

DrRataplan opened this issue Aug 21, 2024 · 0 comments

Comments

@DrRataplan
Copy link
Contributor

DrRataplan commented Aug 21, 2024

Right now, all apps will get serafin letters, example registers and more. Which is not needed.

This is annoying, devs should remove the data, which they might forget. I foresee new apps with that example data actually deployed in production, and hard to track bugs, like unwanted search entries popping up.

Moreover: It does not help that Jinks re-adds removed files on redeploy. When a dev removes all cruft, they have to redo that on update. This may result in them only working on their app, never back-porting fixes to the profiles, benefiting everyone!

How about this (which @line-o and I came up with):

  • We have (a set) of profiles holding example data, like register-examples or serafin-examples. Describing what they hold, functionally.
  • Every profile has a ${PROFILE_NAME}-example-data profile next to it that just combines their preferred example data with the profile. Just a simple extends of the two, plus some config.json defaults applied. The annotate profile has a annotate-example-data counterpart that merges in the graves20.xml , plus the required config.

For demos, and show-offs, instantiate (extend) the example-data profile. If this later moves to a production app with data, just remove the example-data profile, and directly extend from the base profile, so parallel instead of parallel-example-data.

For projects where we have data already, directly instantiate (extend from) the correct profile.

How does this sound? Any thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant