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

Customer facing improvements #781

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

vanmaegima
Copy link
Member

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.

Many customers are performing git merges/cherry picks that will not bring
the git tag information.

We rely on that for support, so update the docs accordingly.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima vanmaegima requested review from kprosise, caiotpereira and a team January 7, 2025 16:55
@vanmaegima vanmaegima force-pushed the customer-facing-improvements branch from c884026 to c8f5663 Compare January 7, 2025 16:57
Copy link
Contributor

@Tim-Anderson Tim-Anderson left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Just minor suggestions, otherwise it looks good!

source/user-guide/troubleshooting/troubleshooting.rst Outdated Show resolved Hide resolved
source/user-guide/troubleshooting/troubleshooting.rst Outdated Show resolved Hide resolved
source/user-guide/troubleshooting/troubleshooting.rst Outdated Show resolved Hide resolved
source/user-guide/troubleshooting/troubleshooting.rst Outdated Show resolved Hide resolved
@kprosise
Copy link
Contributor

kprosise commented Jan 8, 2025

Many users want to downgrade the image.
This shows how to recreate a target so it's picked by aklite daemon.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima vanmaegima force-pushed the customer-facing-improvements branch from c8f5663 to 692beb5 Compare January 8, 2025 12:59
@vanmaegima
Copy link
Member Author

@kprosise Suggestions applied! Feel free to merge.

@kprosise kprosise merged commit 2c0134e into foundriesio:main Jan 8, 2025
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