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

User improvements #612

Merged
merged 11 commits into from
Oct 23, 2023
Merged

User improvements #612

merged 11 commits into from
Oct 23, 2023

Conversation

vanmaegima
Copy link
Member

@vanmaegima vanmaegima commented Oct 18, 2023 •
edited
Loading

Readiness

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

Overview

This brings usability improvements, focusing to ease customer support.
This covers general customer/CS feedback as well.

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.

@vanmaegima vanmaegima requested review from kprosise, angolini and a team October 18, 2023 21:34
@mike-scott
Copy link
Contributor

@vanmaegima These are great changes. LGTM, let's see what @Tim-Anderson says.

@vanmaegima
Copy link
Member Author

@kprosise I've reviewed the vale errors but I think it's ok ignoring them for now (most seem false negatives). Let me know if you'd like me to fix any of them. Also I don't know why the docs run is failing (maybe a package update again?).

kprosise
kprosise approved these changes Oct 19, 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.

Some small suggestions, otherwise it LGTM!

source/reference-manual/security/factory-keys.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 I've reviewed the vale errors but I think it's ok ignoring them for now (most seem false negatives). Let me know if you'd like me to fix any of them. Also I don't know why the docs run is failing (maybe a package update again?).

Yeah, the vale issues can mostly be ignored here...even when technically accurate,  there can be exceptions. 

I'll take a look at why the run is failing.

Tim-Anderson
Tim-Anderson reviewed Oct 19, 2023
View reviewed changes
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.

A few comments and one question

source/reference-manual/linux/linux-distro.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-distro.rst Show resolved Hide resolved
@kprosise
Copy link
Contributor

@vanmaegima Whenever you're ready, just squash and I'll then go ahead and merge.

@vanmaegima
Copy link
Member Author

@kprosise just waiting a couple of days for the lmp-dev-reg comments to close.

@vanmaegima
rm: factory-sources: fix typo
a7457b1 
Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: linux-distro: include distro list and match exact distro names
df1a55c 
This covers feedback from CS team to clarify the use of distros.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: linux-distro: remove i.mx note for mfgtool distro
21955da 
lmp-mfgtool is now used across different SoC families and not only
i.mx, so fix that.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: linux-distro: remove example to change distros
6ca76ae 
This is now covered under Platform Customizing, so remove this
example for maintainability.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: security: summary: reorganize information
72cf52c 
Make the page clearer so we have a directly link to point to customers
that links to the needed information.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: security: factory-keys: improve handling of headers
84c99e4 
This brings us directly links that can be pointed to customers
for each specific architecture.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: security: factory-keys: include note to blog
092ffd4 
This blog brings helpful information when trying to use different
set of keys in the factory.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
rm: security: factory-keys: add note about triggering a boot fw update
7646e79 
This is required in case there is a change in the used build keys.

Signed-off-by: Vanessa Maegima <[email protected]>
@doanac
Copy link
Member

doanac commented Oct 20, 2023

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

angolini
angolini approved these changes Oct 20, 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.

LGTM

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
@doanac
Copy link
Member

doanac commented Oct 20, 2023

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

@vanmaegima
Copy link
Member Author

@kprosise this one should be good to go as well, if vale errors can be ignored

Tim-Anderson
Tim-Anderson approved these changes Oct 20, 2023
View reviewed changes
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.

Just one more nit on spelling error but other than that LGTM

source/user-guide/troubleshooting/troubleshooting.rst Outdated Show resolved Hide resolved
vkhoroz
vkhoroz approved these changes Oct 20, 2023
View reviewed changes
Copy link
Member

@vkhoroz vkhoroz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

This is a good content.
I believe @vanmaegima and @angolini should be able to resolve the leftover nuances.

@doanac
Copy link
Member

doanac commented Oct 20, 2023

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

@vanmaegima
ug: troubleshooting: add common registration errors and solutions
eb14b4c 
Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
ug: troubleshooting: add note about fiovb-container
c6def7f 
This is used to run fiovb_printenv from a container to retrieve custom
RPMB variables.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
ug: troubleshooting: add instructions on changing boot delay
7c6e41c 
Signed-off-by: Vanessa Maegima <[email protected]>
@doanac
Copy link
Member

doanac commented Oct 20, 2023

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

@kprosise kprosise merged commit a4bd80f into foundriesio:main Oct 23, 2023
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angolini angolini angolini approved these changes

@kprosise kprosise kprosise approved these changes

@mike-scott mike-scott mike-scott approved these changes

@Tim-Anderson Tim-Anderson Tim-Anderson approved these changes

@vkhoroz vkhoroz vkhoroz approved these changes

@MrCry0 MrCry0 MrCry0 approved these changes

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

Successfully merging this pull request may close these issues.
8 participants
@vanmaegima @mike-scott @kprosise @doanac @MrCry0 @angolini @vkhoroz @Tim-Anderson