Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

new approach to Golden Path Templates #193

Open
5 tasks
kadel opened this issue Oct 18, 2023 · 1 comment
Open
5 tasks

new approach to Golden Path Templates #193

kadel opened this issue Oct 18, 2023 · 1 comment

Comments

@kadel
Copy link
Member

kadel commented Oct 18, 2023

Goal

What we have been calling golden Path templates are examples of golden path templates.

These examples are not features that users would use as they are in the repo.
Instead, they serve as a foundation for our users and teams to build unique templates.

Since each organization has unique ways of handling applications, a template created for one application will not be universally applicable. As such, Golden Path templates should be viewed as examples that users and teams can use as a blueprint to create their templates.

Acceptance criteria

  • It should be clear that this repo contains examples and not finished (ready to be consumed) templates. Renaming the repo to software-template-examples and explaining this in repo README.md should make this clear.
    • don't forget to update showcase configuration
  • Remove similar templates. Some templates are almost identical; for example, the only difference between quarkus-backend and spring-boot-backend is that they use different skeletons; otherwise, the template is almost identical. Find other similar templates and keep just one example of the same template flow.
  • Each of the remaining GPTs should be well documented. The Readme of the template should explain the purpose of the template and describe any requirements or setups of 3rd party systems. template.yaml itself should contain comments explaining the purpose of each step or parameter. The template description should clearly state that the template is just an example.

Issues in Epic

  • tbd

Notes

@rtaniwa
Copy link

rtaniwa commented Nov 7, 2023

Another thing we might need to capture here is moving away from the term GPT wherever we might have it and standardize on community terminology which I believe is just software templates.

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

No branches or pull requests

3 participants