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

(QEMU) Clarification on ENV VAR Usage #601

Merged
merged 1 commit into from
Sep 21, 2023

Conversation

camilamacedo86
Copy link
Contributor

Readiness

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

Overview

The note provided before the command might lead users to believe that the ENV VAR will automatically be utilized by QEMU during its execution. This can be misleading, especially for those unfamiliar with QEMU or the outlined solution. Personally, the necessity of exporting this variable wasn't clear to me until I reviewed the 'targets' section.

So I would like to suggest the following changes:

Before this PR:

Screenshot 2023-09-20 at 16 41 18

Suggested changes in this PR
Screenshot 2023-09-20 at 16 32 27

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • 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.

@doanac
Copy link
Member

doanac commented Sep 20, 2023

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.

Looks good, thanks!

@kprosise kprosise merged commit b6f5267 into foundriesio:main Sep 21, 2023
1 check passed
@camilamacedo86 camilamacedo86 deleted the fix-misleading-note branch September 22, 2023 18:26
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