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

Add builder in common folder #700

Open
4 tasks
starlightknown opened this issue Apr 23, 2024 · 2 comments
Open
4 tasks

Add builder in common folder #700

starlightknown opened this issue Apr 23, 2024 · 2 comments
Labels
type/enhancement Issue that requests a new feature or improvement.

Comments

@starlightknown
Copy link

Summary

Currently, https://buildpacks.io/docs/for-app-developers/concepts/builder/ this builder in concepts for app developers is different from https://buildpacks.io/docs/for-platform-operators/concepts/builder/ builder in the platform operators section.

What questions should this documentation answer?

Who is the target audience for this documentation?

  • App Developer
  • Buildpack Author
  • Operator
  • Other:

Additional Information

@starlightknown starlightknown added the type/enhancement Issue that requests a new feature or improvement. label Apr 23, 2024
@natalieparellano
Copy link
Member

Thank you for noticing this :) I think the content from both pages could be consolidated and improved. That said I think the platform operators page should be more detailed and should answer (or contain links to) questions such as:

  • How do I find out what is contained within a builder?
  • How do I customize a builder?
  • How do I create my own builder?

Whereas the app developers page should should answer (or contain links to) questions such as:

  • How do I choose a builder from the available providers?
  • How do I set a builder as a default?
  • How do I receive updates to a builder?

The app developers page could link to the platform operators page as a way of going deeper. But, maybe there is a better way to do it that we haven't thought of :)

@starlightknown
Copy link
Author

This is helpful. Yep we can make it different for each persona so that they can understand the same concept with a different point of view

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

No branches or pull requests

2 participants