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 of factory reference manual section #628

Merged
merged 1 commit into from
Nov 17, 2023

Conversation

kprosise
Copy link
Contributor

Style guide lines applied. Removed link to the Yocto Project layers section which is part of the LmP reference manual; this was done to make navigation less confusing, and to keep sections focused.

The section on Factory Sources was placed before the Factory Definition, for better explanatory flow.

QA steps: Ran linter and addressed issues where possible/appropriate. Checked html output in browser, no obvious rendering issues discovered. Ran linkcheck.

This commit addresses FFTK-2790
This commit addresses FFTK-1880
This commit applies to FFTK-2732
This commit applies to FFTK-2730
This commit applies to FFTK-988

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.

@kprosise kprosise requested review from doanac, angolini, vanmaegima and a team November 16, 2023 10:38
@doanac
Copy link
Member

doanac commented Nov 16, 2023

@quaresmajose
Copy link
Member

The image lmp-base-console-image from the public LmP is mentions in some places but I think the default image used in every factory is the lmp-factory-image.

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 few suggestion

source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-sources.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.

review suggestions

source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/sboms.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/sboms.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/api-access.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/ci-webhooks.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
source/reference-manual/factory/factory-definition.rst Outdated Show resolved Hide resolved
@doanac
Copy link
Member

doanac commented Nov 16, 2023

@doanac
Copy link
Member

doanac commented Nov 17, 2023

@doanac
Copy link
Member

doanac commented Nov 17, 2023

Style guide lines applied. Removed link to the Yocto Project layers
section which is part of the LmP reference manual; this was done to make
navigation less confusing, and to keep sections focused.

The section on Factory Sources was placed before the Factory Definition,
for better explanatory flow.

QA steps: Ran linter and addressed issues where possible/appropriate.
Checked html output in browser, no obvious rendering issues discovered.
Ran linkcheck.

This commit addresses FFTK-2790
This commit addresses FFTK-1880
This commit applies to FFTK-2732
This commit applies to FFTK-2730
This commit applies to FFTK-988

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

doanac commented Nov 17, 2023

@kprosise kprosise merged commit adcd244 into foundriesio:main Nov 17, 2023
2 of 3 checks passed
@kprosise kprosise deleted the cleanup-factory branch January 9, 2024 10:28
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.

5 participants