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.

Sign up for GitHub

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

Jump to bottom

Enhance Documentation: Clarifications and Helpers for Graphical Booting in QEMU #606

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Enhance Documentation: Clarifications and Helpers for Graphical Booting in QEMU #606

merged 1 commit into from
Oct 9, 2023

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Sep 27, 2023 •
edited
Loading

Readiness

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

Overview

Why merge this PR? What does it solve?

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 27, 2023

Docs for 6a396ce are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2373/docs/artifacts/html/index.html

@camilamacedo86 camilamacedo86 changed the title Enhance Documentation: Clarifications and Helpers for Graphical Booting in QEMU (WIP) - Enhance Documentation: Clarifications and Helpers for Graphical Booting in QEMU Sep 27, 2023
vanmaegima
vanmaegima reviewed Sep 28, 2023
View reviewed changes
Copy link
Member

@vanmaegima vanmaegima left a comment

Choose a reason for hiding this comment

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

I left some comments, feel free to reach out in case you want to discuss any of the topics.

source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
@doanac
Copy link
Member

doanac commented Oct 2, 2023

Docs for 4361346 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2376/docs/artifacts/html/index.html

@camilamacedo86 camilamacedo86 changed the title (WIP) - Enhance Documentation: Clarifications and Helpers for Graphical Booting in QEMU Enhance Documentation: Clarifications and Helpers for Graphical Booting in QEMU Oct 2, 2023
@doanac
Copy link
Member

doanac commented Oct 2, 2023

Docs for c228562 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2377/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 2, 2023

Docs for 95d4b27 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2378/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 2, 2023

Docs for 621bb31 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2379/docs/artifacts/html/index.html

@camilamacedo86 camilamacedo86 reopened this Oct 2, 2023
angolini
angolini requested changes Oct 2, 2023
View reviewed changes
Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

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

It's great to have eyes unfamiliar with the yocto flow to review the docs! I just realized it could be tough to understand how to change the Distro (something that, for me, is trivial). Thanks a lot for highlighting that!
I don´t think the commands belong to RM, but I'm sure we can find a better fit for than, as I think they are critical!

Thanks for the PR!

source/reference-manual/linux/linux-distro.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-distro.rst Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
@doanac
Copy link
Member

doanac commented Oct 2, 2023

Docs for 3149abd are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2382/docs/artifacts/html/index.html

@camilamacedo86

This comment was marked as outdated.

Sign in to view
@angolini
Copy link
Collaborator

angolini commented Oct 2, 2023

Let's wait for Katrina's comment. I don't know how deep she is into the RM cleanup.

kprosise
kprosise reviewed Oct 3, 2023
View reviewed changes
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.

Left some feedback/suggestions. I will give it another pass later. Thanks for all this work, it is really appreciated.

source/reference-manual/linux/linux-distro.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-distro.rst Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
source/reference-manual/qemu/qemu-instructions.template Outdated Show resolved Hide resolved
@camilamacedo86 camilamacedo86 force-pushed the ui branch 3 times, most recently from 4ed75ed to 4ad10cb Compare October 3, 2023 21:38
@camilamacedo86
Copy link
Contributor Author

Hi @angolini and @kprosise

I tried to address all suggestions.
Please, feel free to let me know if any further changes should be made.
Btw, I like the suggestion about the place to put the small guidance to help out people.

@camilamacedo86
Copy link
Contributor Author

Hi @angolini,

I just realized it could be tough to understand how to change the Distro (something that, for me, is trivial).

I could figure it out but I really think that is hard for someone out of context to know exactly where to set up the DISTRO
that when pushing the commit for ci-script it will not build a target etc.

@camilamacedo86 camilamacedo86 reopened this Oct 3, 2023
kprosise
kprosise approved these changes Oct 5, 2023
View reviewed changes
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.

one last little suggestion, but otherwise it looks good!

source/user-guide/lmp-customization/lmp-customization.rst Outdated Show resolved Hide resolved
MrCry0
MrCry0 reviewed Oct 6, 2023
View reviewed changes
source/reference-manual/linux/linux-distro.rst Outdated
LmP Wayland and LmP XWayland
****************************
*********************************
Copy link
Contributor

Choose a reason for hiding this comment

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

This change seems unneeded. IIRC the "underline" should be the same length as the underlined text.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

reverted

@camilamacedo86 @kprosise
Enhance Documentation: Clarifications and Helpers for Graphical Booti…
77a369c 
…ng in QEMU

Signed-off-by: Camila Macedo <[email protected]>
Co-authored-by: Katrina Prosise <[email protected]>
@camilamacedo86 camilamacedo86 requested a review from MrCry0 October 9, 2023 13:12
MrCry0
MrCry0 approved these changes Oct 9, 2023
View reviewed changes
Copy link
Contributor

@MrCry0 MrCry0 left a comment

Choose a reason for hiding this comment

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

LGTM

@kprosise kprosise merged commit 96dcf24 into foundriesio:main Oct 9, 2023
1 check passed
@camilamacedo86 camilamacedo86 deleted the ui branch October 10, 2023 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kprosise kprosise kprosise approved these changes

@angolini angolini angolini approved these changes

@MrCry0 MrCry0 MrCry0 approved these changes

@vanmaegima vanmaegima Awaiting requested review from vanmaegima

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@camilamacedo86 @doanac @angolini @MrCry0 @vanmaegima @kprosise