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

ug: Minor fixes in aklite CLI documentation #753

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

detsch
Copy link
Member

@detsch detsch commented Sep 12, 2024

A few fixes that I've missed from PR #734.


PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@detsch
Copy link
Member Author

detsch commented Sep 12, 2024

@kprosise , I've just noticed the adjustments for some of your suggestions were missing in PR #734. File was not saved to the last state when I've executed the commit amend command 🤦. Sorry about that. Please merge this PR as well to fix it.

@detsch detsch requested a review from kprosise September 12, 2024 20:41
@detsch detsch force-pushed the detsch-document-aklite-cli-2 branch from 54d2839 to 9baa24c Compare September 12, 2024 20:54
@doanac
Copy link
Member

doanac commented Sep 12, 2024

@kprosise
Copy link
Contributor

@kprosise , I've just noticed the adjustments for some of your suggestions were missing in PR #734. File was not saved to the last state when I've executed the commit amend command 🤦. Sorry about that. Please merge this PR as well to fix it.

No worries, I should have caught that myself!

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

Thanks! Will go ahead and merge now

@kprosise kprosise merged commit f5a1ce4 into foundriesio:main Sep 13, 2024
1 of 3 checks passed
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