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

Improve documentation and description metadata #440

Merged
merged 1 commit into from
Nov 23, 2023

Conversation

edmorley
Copy link
Member

@edmorley edmorley commented Nov 23, 2023

The repo README has been overhauled, to:

  • Give more context as to what a builder is, and link to the upstream docs.
  • Emphasise that these images are experimental and not yet used for "normal" Heroku builds.
  • Make it easier to understand the difference between the image variants, including attributes such as run image and lifecycle version.
  • Make the usage instructions more accessible for beginners.
  • Give users breadcrumbs to follow when trying to work out where to file issues.

The "update lifecycle" GitHub Actions workflow has been modified so that it now also modifies the lifecycle version in the README in addition to that in the builder manifests.

Lastly, the description metadata used for each builder (that is shown by pack builder inspect) has also been updated to mention deprecations and bring the descriptions inline with that used upstream:
https://github.com/buildpacks/pack/blob/9c8223caef09a8f73b9c145c0ccf03ab704aac53/internal/builder/suggested_builder.go#L16-L23

GUS-W-14194789.

@edmorley edmorley self-assigned this Nov 23, 2023
@edmorley edmorley marked this pull request as ready for review November 23, 2023 13:54
@edmorley edmorley requested a review from a team as a code owner November 23, 2023 13:54
The repo README has been overhauled, to:
- Give more context as to what a builder is, and link to the upstream docs.
- Emphasise that these images are experimental and not yet used for
  "normal" Heroku builds.
- Make it easier to understand the difference between the image variants,
  including attributes such as run image and lifecycle version.
- Make the usage instructions more accessible for beginners.
- Give users breadcrumbs to follow when trying to work out where
  to file issues.

The "update lifecycle" GitHub Actions workflow has been modified so
that it now also modifies the lifecycle version in the README in addition
to that in the builder manifests.

Lastly, the description metadata used for each builder (that is shown by
`pack builder inspect`) has also been updated to mention deprecations
and bring the descriptions inline with that used upstream:
https://github.com/buildpacks/pack/blob/9c8223caef09a8f73b9c145c0ccf03ab704aac53/internal/builder/suggested_builder.go#L16-L23

GUS-W-14194789.
@edmorley edmorley force-pushed the edmorley/overhaul-docs branch from 463e5ba to 343a221 Compare November 23, 2023 14:03
@edmorley edmorley merged commit 71737a3 into main Nov 23, 2023
42 checks passed
@edmorley edmorley deleted the edmorley/overhaul-docs branch November 23, 2023 15:28
@edmorley edmorley mentioned this pull request Aug 29, 2024
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