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

Cleanup reference manual lmp section #633

Merged
merged 1 commit into from
Dec 13, 2023

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Dec 5, 2023

reference-manual/linux pages were checked and edited for grammar, spelling, and style.

Pages which were a better fit for the user-guide were relocated under lmP Customization; an index page for that section was also added.

Cleanup and possible relocation of linux-updating was skipped to avoid merge conflicts.

Redirects added for moved pages.

QA steps: checked rendered html. Ran linter within editor. Ran linkcheck. No issues to report, however this is a relatively large commit.

This commit addresses FFTK 2791
This commit addresses FFTK 1887
This commit addresses FFTK 1741
This commit addresses FFTK 1681
This commit applies to FFTK 1687
This commit applies to FFTK 2730
This commit applies to FFTK 2732
This commit applies to FFTK 2731
This commit applies to FFTK 1702
This commit applies to FFTK 988
This commit applies to FFTK 2733

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

This is a pretty large commit. Following cleanup commits will be a touch more atomic. For those reviewing, feel free to only review changes on pages/subjects you are familiar with.

@doanac
Copy link
Member

doanac commented Dec 5, 2023

@doanac
Copy link
Member

doanac commented Dec 5, 2023

@doanac
Copy link
Member

doanac commented Dec 6, 2023

@doanac
Copy link
Member

doanac commented Dec 6, 2023

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.

Only minor suggestions, otherwise it's a LGTM

source/reference-manual/linux/building-sdk.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-dev-mode.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-oss-compliance.rst Outdated Show resolved Hide resolved
Copy link
Contributor Author

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

Suggestions from feedback

source/reference-manual/linux/building-sdk.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-dev-mode.rst Outdated Show resolved Hide resolved
source/reference-manual/linux/linux-oss-compliance.rst Outdated Show resolved Hide resolved
`reference-manual/linux` pages were checked and edited for grammar,
spelling, and style.

Pages which were a better fit for the user-guide were relocated under
lmP Customization; an index page for that section was also added.

Cleanup and possible relocation of linux-updating was skipped to avoid
merge conflicts.

Redirects added for moved pages.

QA steps: checked rendered html. Ran linter within editor. Ran
linkcheck. No issues to report, however this is a relatively large commit.

This commit addresses FFTK 2791
This commit addresses FFTK 1887
This commit addresses FFTK 1741
This commit addresses FFTK 1681
This commit applies to FFTK 1687
This commit applies to FFTK 2730
This commit applies to FFTK 2732
This commit applies to FFTK 2731
This commit applies to FFTK 1702
This commit applies to FFTK 988
This commit applies to FFTK 2733

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@doanac
Copy link
Member

doanac commented Dec 12, 2023

@kprosise kprosise merged commit 618188f into foundriesio:main Dec 13, 2023
1 of 3 checks passed
@kprosise kprosise deleted the cleanup-linux branch December 13, 2023 09:43
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