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.

Sign up for GitHub

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

Jump to bottom

Pack CLI install docs page now 404s #673

Open
edmorley opened this issue Mar 8, 2024 · 1 comment · Fixed by #674
Open

Pack CLI install docs page now 404s #673

edmorley opened this issue Mar 8, 2024 · 1 comment · Fixed by #674

Comments

@edmorley
Copy link
Contributor

edmorley commented Mar 8, 2024 •
edited
Loading

Lots of our buildpack/builder related docs link to https://buildpacks.io/docs/tools/pack/ (eg guides saying "First, make sure you have Pack CLI installed: <link to that page>"), however, after the recent docs reorganisation that page now 404s.

Searching the docs site it seems the new location for the page is now:
https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/

However:

  1. Should there be a redirect to the new page to prevent the 404? (Plus maybe for any other higher-priority pages of the ones that were moved)
  2. Does including Pack CLI instructions under "for-platform-operators" make sense? Our end users won't see themselves as platform operators, they are app developers trying to just build their app.
edmorley added a commit to heroku/cnb-builder-images that referenced this issue Mar 8, 2024
@edmorley
Fix broken upstream docs URL in deprecation message
d49bd55 
The upstream CNB project has rearranged a number of the docs pages,
breaking some existing links such as:
https://buildpacks.io/docs/tools/pack/cli/pack_config_default-builder/

I've filed buildpacks/docs#673 for potentially
adding redirects, however, for the deprecation warning use-case, it
makes more sense for us to just inline the CLI command rather than
link out to the docs.
@edmorley edmorley mentioned this issue Mar 8, 2024
Merged
edmorley added a commit to heroku/cnb-builder-images that referenced this issue Mar 8, 2024
@edmorley
Fix broken upstream docs URL in deprecation message (#476)
788a4a5 
The upstream CNB project has rearranged a number of the docs pages,
breaking some existing links such as:
https://buildpacks.io/docs/tools/pack/cli/pack_config_default-builder/

I've filed buildpacks/docs#673 for potentially
adding redirects, however, for the deprecation warning use-case, it
makes more sense for us to just inline the CLI command rather than
link out to the docs.
@natalieparellano natalieparellano mentioned this issue Mar 8, 2024
Merged
@natalieparellano
Copy link
Member

Should there be a redirect to the new page to prevent the 404? (Plus maybe for any other higher-priority pages of the ones that were moved)

This should be fixed in #674 - some aliases were added when we moved stuff but the aliases to pack pages were incorrect.

Does including Pack CLI instructions under "for-platform-operators" make sense? Our end users won't see themselves as platform operators, they are app developers trying to just build their app

Fair point. Maybe the bulk for the pack documentation should live under app dev "how to" and any content about using pack in CI should go in the platform section. I don't know. This was one point that came up in discussion around buildpacks/rfcs#296 but we went ahead with the proposal because we couldn't think of a better alternative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix pack aliases buildpacks/docs
2 participants
@edmorley @natalieparellano