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

Document the choices of OTA operations #670

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Document the choices of OTA operations #670

merged 1 commit into from
Feb 21, 2024

Conversation

Tim-Anderson
Copy link
Contributor

@Tim-Anderson Tim-Anderson commented Jan 24, 2024 •
edited
Loading

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • [x ] 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 Jan 24, 2024

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

vanmaegima
vanmaegima reviewed Jan 24, 2024
View reviewed changes
source/user-guide/custom-sota-client.rst Outdated
This is not always the desired operation. There are 3 ways to control this operation

1. Callbacks
2. aktualizr-lite manual command line interface (Client)
Copy link
Member

Choose a reason for hiding this comment

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

I think we decided not to advertise that for now?
Maybe we can drop this and focus on custom sota x callbacks and check our customer feedback.

source/user-guide/custom-sota-client.rst Outdated
step through the install process. Unlike the callback method, this uses return codes to provice the status and
does not perform the reboot of the device automatically.

.. _`manual mode`:
Copy link
Member

Choose a reason for hiding this comment

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

Same comment here, we were always against running manual commands as we cannot test every single interaction (we also changed our docs a while ago stating this is not supported and not recommended).

@vanmaegima
Copy link
Member

Thank you @Tim-Anderson for the help with this. I would say to remove CLI stuff until we have a chance to discuss with Mike/Mike Sul. Callbacks docs is what we are lacking at the moment.

@doanac
Copy link
Member

doanac commented Jan 29, 2024

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

@mike-scott mike-scott changed the title WIP: document the 3 choices of OTA operations WIP: document the choices of OTA operations Jan 29, 2024
kprosise
kprosise approved these changes Jan 30, 2024
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.

Style/grammar suggestions, otherwise it lgtm

source/user-guide/custom-sota-client.rst Outdated Show resolved Hide resolved
source/user-guide/custom-sota-client.rst Outdated Show resolved Hide resolved
source/user-guide/custom-sota-client.rst Outdated Show resolved Hide resolved
source/user-guide/custom-sota-client.rst Outdated Show resolved Hide resolved
source/user-guide/custom-sota-client.rst Outdated Show resolved Hide resolved
source/user-guide/custom-sota-client.rst Outdated Show resolved Hide resolved
@vanmaegima
Copy link
Member

@Tim-Anderson What are we missing on this?
@kprosise @foundriesio/customer-success Do you think it's a good idea to land this on v93?

@kprosise
Copy link
Contributor

kprosise commented Feb 8, 2024

@vanmaegima I have no problem including this in v93 if it is ready then.

@doanac
Copy link
Member

doanac commented Feb 20, 2024

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

@doanac
Copy link
Member

doanac commented Feb 20, 2024

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

@Tim-Anderson Tim-Anderson changed the title WIP: document the choices of OTA operations Document the choices of OTA operations Feb 20, 2024
@doanac
Copy link
Member

doanac commented Feb 20, 2024

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

@kprosise
Copy link
Contributor

LGTM

@kprosise kprosise merged commit d4847ee into foundriesio:main Feb 21, 2024
2 of 3 checks passed
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

@vanmaegima vanmaegima vanmaegima 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.
5 participants
@Tim-Anderson @doanac @vanmaegima @kprosise @MrCry0