Skip to content

Add ADR for renaming templates #21

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

rocketnova
Copy link

@rocketnova rocketnova commented Apr 11, 2024

Ticket

Changes

What was added, updated, or removed in this PR.

  • ADR for renaming application template directories

Context for reviewers

Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

See ADR.

Testing

Screenshots, GIF demos, code examples or output to help show the changes working as expected. ProTip: you can drag and drop or paste images into this textbox.

N/A


## Decision Outcome

1. Use a truncated version of the template application name (e.g. `app-nextjs` for `template-application-nextjs`, `app-flask` for `template-application-flask`) for the application directory

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My mundane POV is that this feels like a good place to use flask-app rather than app-flask.

Besides that, I'm hard +1 on renaming away from just app, for all the reasons mentioned here

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the comment! I tend to follow "bigger-to-smaller" in most things (e.g. YYYY-MM-DD) so that things naturally sort, which is how we ended up with template-application-flask, but I don't feel super strongly about it. Curious to see what other people think.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't have an opinion but Rocket's explanation makes sense to me.

Copy link
Contributor

@sawyerh sawyerh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of naming the app something that is easier to find-and-replace

Copy link

@coilysiren coilysiren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍!

Copy link
Contributor

@lorenyu lorenyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At a high level seems like a reasonable direction, but I'm having difficulty evaluating without seeing the impact on:

  • Setup process for integrating apps and infra (right now infra assumes apps are named app, so there needs to be an additional step that updates the infra template to get them to work)
  • Update process for updating the templates (both app and infra)
  • Impact on template development workflows, in particular (a) template CD which uses update process and (b) dev workflow which often relies on generating a patch from changes in a branch on platform-test and applying them to a branch on template-infra.

Copy link

@aligg aligg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read this over in detail and makes sense to me, like the idea of avoiding app/app in next.js

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

Successfully merging this pull request may close these issues.

6 participants