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

CLI docs #584

Merged
merged 28 commits into from
Oct 30, 2023
Merged

CLI docs #584

merged 28 commits into from
Oct 30, 2023

Conversation

plumbis
Copy link
Collaborator

@plumbis plumbis commented Oct 25, 2023

Includes CLI docs covering everything except beta trace and beta xpkg init.

Signed-off-by: Pete Lumbis pete@upbound.io

Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
@netlify
Copy link

netlify bot commented Oct 25, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit e1cb0f9
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/6540315dd5900900081793e5
😎 Deploy Preview https://deploy-preview-584--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance:
Accessibility:
Best Practices:
SEO:
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
content/v1.14/cli/_index.md Outdated Show resolved Hide resolved
content/v1.14/cli/_index.md Show resolved Hide resolved
content/v1.14/cli/command-reference.md Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a fantastic effort @plumbis to get our CLI docs going - I really like it and appreciate it!! dropped a few comments that may help with clarifying some of the content here, feel free to push back on anything you think doesn't actually improve things 😇

content/v1.14/cli/_index.md Outdated Show resolved Hide resolved
content/v1.14/cli/_index.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
For example, to update to version 0.42.0 of the
[AWS S3 provider](https://marketplace.upbound.io/providers/upbound/provider-aws-s3/v0.42.0):

`crossplane xpkg update provider xpkg.upbound.io/upbound/provider-aws-s3:v0.42.0`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

interesting, i didn't know we had this functionality 😂 - does it look for existing installed packages from the same registry, org, and repo then tries to upgrade what it finds to the new version here? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it just defaults the name from the package the same way xpkg install does if you omit the name.

content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
content/v1.14/cli/command-reference.md Show resolved Hide resolved
content/v1.14/cli/command-reference.md Show resolved Hide resolved
content/v1.14/cli/command-reference.md Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really appreciate your effort here @plumbis, but are we really sure we are going to be able to maintain this? Looking at other examples such as istioctl and kubectl which then points to https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands. It feels like the common pattern is to provide an high level overview of common flags and functionalities, showcase common scenarios and then point to the generated documentation directly for all the nitty gritty details, which would make sense to me as a user.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the concern is valid but if we have enough commands that it's a problem, that's a good problem to have.

For now I'd like to keep it manually updated.

Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Pete Lumbis <pete@upbound.io>
@plumbis plumbis merged commit 4e970ec into crossplane:v1.14-release Oct 30, 2023
6 of 7 checks passed
@plumbis plumbis deleted the v1.14 branch October 30, 2023 22:42
negz pushed a commit to negz/docs that referenced this pull request Oct 30, 2023
plumbis added a commit to plumbis/crossplane-docs that referenced this pull request Oct 31, 2023
plumbis added a commit that referenced this pull request Oct 31, 2023
plumbis added a commit that referenced this pull request Nov 1, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
plumbis added a commit that referenced this pull request Nov 1, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
plumbis added a commit that referenced this pull request Nov 1, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
plumbis added a commit that referenced this pull request Nov 1, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
plumbis added a commit that referenced this pull request Nov 1, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
plumbis added a commit that referenced this pull request Nov 1, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
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.

4 participants