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

Address duplication of docs regarding utility buildpacks #135

Open
3 tasks
fg-j opened this issue Apr 6, 2021 · 1 comment
Open
3 tasks

Address duplication of docs regarding utility buildpacks #135

fg-j opened this issue Apr 6, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@fg-j
Copy link

fg-j commented Apr 6, 2021

What happened?

Currently, many Paketo language family buildpacks' order groups include utility buildpacks like the CA Certificates buildpack and the Procfile buildpack. This means that language families share some user-facing configurability.

Right now, we document this configurability to different degrees in three places: the "Configuring Paketo Buildpacks" section of the site, within each language family buildpack's docs pages, and in the READMEs on the utility buildpacks' repos. We've got duplicated docs and a smattering of different info in different places.

It'd be great to somehow consolidate this information or have a single source of truth for it that can be propagated to multiple locations. This will reduce the likelihood that different copies of similar docs diverge and fall out of date.

Checklist

  • I have included log output.
  • The log output includes an error message.
  • I have included steps for reproduction.
@kvedurmu
Copy link
Member

kvedurmu commented Apr 7, 2021

This makes sense to me. I would like to see us linking to the Configuring Paketo Buildpacks page as much as possible for all of these utility buildpacks. Once this PR gets merged, we should have documentation for all Utility Buildpacks that we can link to: Procfiles, CA Cert, Image Labels, Environment Variables.

@andymoe andymoe added the documentation Improvements or additions to documentation label Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants