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

feat(doc): true-composable-templates #805

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

ekeren
Copy link
Contributor

@ekeren ekeren commented Feb 25, 2024

Docs updates should not be submitted in this repository

Our doc site content is being automatically updated from Wing repository docs folder.

Please submit any changes to the docs as a PR here

Copy link

vercel bot commented Feb 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
wing-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 25, 2024 5:41pm

Copy link
Contributor

@ShaiBer ShaiBer left a comment

Choose a reason for hiding this comment

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

Hey, very nice piece!
My top level feedback is that I think that before the "Template Composition" section that talks about why Wing is preferable to templates, you should add a section that talks in general about the problems with templates

a workshop. I told him that the audience was able to create a simple but powerful setup that
worked locally and was deployable on AWS using terraform. I noted that if I would have tried to
achieve this without Wing, it would have taken me two weeks to get to the same point. However,
the Product Manager offered a perspective that prompted deep reflection. He acknowledged the
Copy link
Contributor

Choose a reason for hiding this comment

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

In the first part where you describe the conversation with "the product manager" consider using a more personal and conversational tone. Maybe instead of "the product manager", give them a name and add some personal details about them. Make this feel a bit more intimate and less like a detached description of a conversation. If you give your friend a name, it will also make it less awkward down the story when you refer to them.

developers to tweak them for specific needs. This layer would enable any developer to adapt the
template to their unique project requirements.

#### Why are we talking about Templates?
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add a bunch of concrete examples and links to solutions from the platform engineering space

working with it. Templates are a very powerful tool with a very appealing time to value, no wonder
this product manager asked about Wing vs a template on any technology.

#### Templates and Their Limits
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Templates and Their Limits
#### What's wrong with templates?

Maybe use a bit more conversational tone

and innovation. They’re great for getting off the ground quickly but may not always cater to the
nuanced needs of every project. The ability to customize a template does introduce flexibility,
but this can also introduce complexity, requiring developers to navigate and manipulate the
template's constraints to suit their specific objectives.
Copy link
Contributor

Choose a reason for hiding this comment

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

The text feels a bit too abstract. Maybe lead with a concrete example

Copy link
Contributor

Choose a reason for hiding this comment

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

One example I like to give is what happens if there's a security bug in the template and now we have to chase all copies of the template to fix this bug.

but this can also introduce complexity, requiring developers to navigate and manipulate the
template's constraints to suit their specific objectives.

#### Template Composition
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Template Composition
#### Composition instead of templates

It does know what is required in order to use itself with other resources.
The system identified this indirect composition of resource and call the onLift method of the Bedrock model with the callee as the host.

#### The Real Value of Using Wing
Copy link
Contributor

Choose a reason for hiding this comment

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

This title is a bit fluffy

When a project grows, they grow outside the boundaries of what we initially thought should be the template version,
the project setup and architecture needs to allow developers to modify their architecture by allowing developers to refactor and change patterns in the way that fits the current business requirements.

## Conclusion
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add something personal here

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.

3 participants