Align and reorganize qemu pages #831
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vanmaegima
reviewed
May 9, 2025
source/user-guide/qemu/qemu.rst
Outdated
| :maxdepth: 1 | ||
|
|
||
| x86_64 | ||
| emulation-with-qemu |
Member
There was a problem hiding this comment.
Is there a benefit on keeping this page? Since it was introduced, it seems a bit redundant for me, I may be missing some detail there.
I think the note about QEMU in https://ci.foundries.io/projects/fio-docs/builds/2912/docs/artifacts/html/getting-started/flash-device/index.html#prerequisites-and-pre-work pointing directly to the QEMU general pages will do the work.
Contributor
Author
There was a problem hiding this comment.
I am more than okay with removing it!
kprosise
force-pushed
the
align-qemu-pages
branch
from
14f9f5b to
9dd7d5d
Compare
Emulation with QEMU page deleted, as it does not serve much of a purpose. Other QEMU pages edited to have one parameter per line for the command example; this is so it can be easier to visually parse. QA Steps: Built HTML with no issues or warnings. Checked rendered output. Edited with linter plugin on. This commit addresses issue FFTK-4004, "Align QEMU pages" Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
kprosise
force-pushed
the
align-qemu-pages
branch
from
9dd7d5d to
87f71ed
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Emulation with QEMU moved from Getting Started to User Guide alongside the other QEMU pages. QEMU command made to match.
Other QEMU pages edited to have one parameter per line for the command example so as to match; this makes sense as it can be easier to visually parse.
QA Steps: Built HTML with no issues or warnings. Checked rendered output. Edited with linter plugin on.
This commit addresses issue FFTK-4004, "Align QEMU pages"
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
Overview
--
Checklist
make linkcheck.-s, --signoff).-S, --gpg-sign).Comments
Changes considered but ruled out for the time being:
includefor the shared command in the tutorial: The use ofincludein the docs is being reevaluated as it prevents the PDF version from rendering correctly.