-
Notifications
You must be signed in to change notification settings - Fork 167
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
Feature/119 add pack docs #161
Conversation
6b96daa
to
fe32890
Compare
Signed-off-by: David Freilich <[email protected]>
Signed-off-by: David Freilich <[email protected]>
Signed-off-by: David Freilich <[email protected]>
fe32890
to
2053012
Compare
Signed-off-by: David Freilich <[email protected]>
content/docs/reference/pack/pack.md
Outdated
|
||
### Synopsis | ||
|
||
CLI for building apps using Cloud Native Buildpacks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do all the Synopsis sections repeat the description?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like Synopsis prints out the cmd.Long
description, and that just combines the cmd.Short
with the usage if there is no separate long description.
I don't think we want the generated pages to be committed at all. They should be generated as part of the build process but excluded from git via gitignore otherwise we're going to have a lot of commits where only generated content is updated. |
But if they are not committed, how will they be part of the docs? |
Signed-off-by: David Freilich <[email protected]> Co-authored-by: Joe Kutner <[email protected]>
@jromero With this being approved, any further feelings on that? Should I not include the generated files, and then only generate them as part of the deployment procedure, or do we want the option to make adjustments to the documentation? |
Still trying to understand how this would work if we don’t have them generated as part of the
|
@jromero That's fair. So add the pack.md docs generated to the .gitignore, add |
Yes. That's my vote. |
* Update gitignore to ignore generated files Signed-off-by: David Freilich <[email protected]>
Feature/119 add pack docs
This PR adds Pack CLI documentation as a reference folder, cataloguing every pack cli command. There is currently no release with the required command (
cmd.NewPackCommand
), so it is currently inoperable (until buildpacks/pack#701 is merged, in some fashion).I would combine it with a Github Action to regenerate the CLI commands on a new release - but I assume the action shouldn't commit, but should rather make it a PR...
Resolves #119