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 ota reference manual #635

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Conversation

kprosise
Copy link
Contributor

Grammar and style changes made.
Updates to content may be required.

QA: Ran linter in editor.
Checked rendered output in browser, no rendering issues spotted. Linkcheck encountering issues not believed to be associated with any changes made in this commit.

This commit addresses FFTK-2792
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

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 Dec 13, 2023

Copy link
Member

@vkhoroz vkhoroz left a comment

Choose a reason for hiding this comment

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

@kprosise I think you're making a great improvement to our docs with this PR.

However, closer to the end I've completely lost attention.
It would be much easier to grasp what's really changed if this PR is split into individual commits, each targetting a specific problem you tried to fix.
For example, the pure sentence split or a global replacement of target -> Target, would look the best as separate commits.

I know, it is way too late, and you did a lot of great job, so I don't want to force you redoing this.
We may try pursuing this PR as is.
It is just something to consider for the future.

source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/configuring.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.

Adding suggestions...

source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/advanced-tagging.rst Outdated Show resolved Hide resolved
@doanac
Copy link
Member

doanac commented Dec 15, 2023

@doanac
Copy link
Member

doanac commented Dec 15, 2023

@doanac
Copy link
Member

doanac commented Dec 15, 2023

@doanac
Copy link
Member

doanac commented Dec 15, 2023

@doanac
Copy link
Member

doanac commented Dec 15, 2023

@doanac
Copy link
Member

doanac commented Dec 15, 2023

@doanac
Copy link
Member

doanac commented Dec 15, 2023

Grammar and style changes made.
Updates to content may be required.

QA: Ran linter in editor.
Checked rendered output in browser, no rendering issues spotted.
Linkcheck encountering issues not believed to be associated with any
changes made in this commit.

This commit addresses FFTK-2792
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

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

doanac commented Dec 19, 2023

@kprosise kprosise requested review from vkhoroz and doanac December 19, 2023 09:55
Added additional suggestions

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

doanac commented Dec 22, 2023

@kprosise kprosise merged commit b45edf4 into foundriesio:main Dec 22, 2023
1 of 3 checks passed
@kprosise kprosise deleted the cleanup-ota branch December 22, 2023 11:33
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