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

Feature/119 add pack docs #161

Merged
merged 8 commits into from
Jul 23, 2020
Merged

Feature/119 add pack docs #161

merged 8 commits into from
Jul 23, 2020

Conversation

dfreilich
Copy link
Member

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

@dfreilich dfreilich force-pushed the feature/119-add-pack-docs branch from 6b96daa to fe32890 Compare June 19, 2020 18:26
@jromero jromero changed the base branch from master to main June 19, 2020 18:30
@dfreilich dfreilich mentioned this pull request Jul 2, 2020
2 tasks
@dfreilich dfreilich force-pushed the feature/119-add-pack-docs branch from fe32890 to 2053012 Compare July 10, 2020 16:50
Signed-off-by: David Freilich <[email protected]>
@dfreilich dfreilich marked this pull request as ready for review July 10, 2020 17:40
@dfreilich dfreilich requested a review from a team as a code owner July 10, 2020 17:40
@dfreilich
Copy link
Member Author

With the release of pack v0.12.0, this is now operable.

Some images:
Initial (pack CLI is in reference, and not shown):
image

When reference is expanded, Pack CLI is last:
image

The initial Pack CLI page:
image

content/docs/reference/pack/_index.md Outdated Show resolved Hide resolved

### Synopsis

CLI for building apps using Cloud Native Buildpacks
Copy link
Member

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?

Copy link
Member Author

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.

@jromero
Copy link
Member

jromero commented Jul 13, 2020

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.

@dfreilich
Copy link
Member Author

But if they are not committed, how will they be part of the docs?

@jkutner jkutner self-requested a review July 23, 2020 15:16
@dfreilich
Copy link
Member Author

@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?

@jromero
Copy link
Member

jromero commented Jul 23, 2020

@dfreilich

Still trying to understand how this would work if we don’t have them generated as part of the make build process. These are my thoughts:

  1. We would want them generated every time there is a new version of pack. This would void any hope of trying to get the docs updated outside of the pack release process otherwise they would get stomped on when the next release comes out.
  2. Instead of having to create a PR/commit to the docs for pack related docs I think it would be easier to trigger a deployment of the new docs similar to what we do for pack version which we use in other parts of the docs.

@dfreilich
Copy link
Member Author

@jromero That's fair. So add the pack.md docs generated to the .gitignore, add update-docs to make build (so we don't need to add anything new to the update process, it will anyways update the docs with a new release of pack), and then if we any issues with that we can always change it to have the docs included?

@jromero
Copy link
Member

jromero commented Jul 23, 2020

Yes. That's my vote.

dfreilich and others added 2 commits July 23, 2020 15:50
* Update gitignore to ignore generated files

Signed-off-by: David Freilich <[email protected]>
@jromero jromero merged commit 9226158 into main Jul 23, 2020
@jromero jromero deleted the feature/119-add-pack-docs branch July 23, 2020 19:57
github-actions bot pushed a commit that referenced this pull request Jul 23, 2020
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.

Document pack cli commands
3 participants