-
Notifications
You must be signed in to change notification settings - Fork 27
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
Custom sota dedicated repo #723
Conversation
Docs for 35e369b are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2689/docs/artifacts/html/index.html |
Docs for 35e369b are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2690/docs/artifacts/html/index.html |
@@ -90,12 +90,13 @@ In addition to the default daemon mode, users can run it as a CLI utility and pe | |||
|
|||
.. prompt:: bash | |||
|
|||
/build-custom/custom-sota-client --help | |||
sotactl --help | |||
Usage: | |||
custom-sota-client [cmd] [options] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to update print_usage()
, and this line accordignly, with the new executable name (instead of custom-sota-client
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in both, the sotactl
repo and in this doc.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
The example `SOTA client`_ in aktualizr-lite is a great place to start experimenting. | ||
The example `SOTA client`_ is a great place to start experimenting. | ||
The ``meta-lmp`` layer includes a recipe_ that runs this example as the default SOTA client. | ||
Later, this can serve as an example to copy/paste into a Factory specific recipe. | ||
|
||
.. _recipe: | ||
https://github.com/foundriesio/meta-lmp/tree/main/meta-lmp-base/recipes-sota/custom-sota-client |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The recipe path will still be the same?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think that's fine to leave the recipe name as it is now.
35e369b
to
19e694e
Compare
Docs for 19e694e are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2691/docs/artifacts/html/index.html |
The source code of the custom sota client example is moved from the aklite repo to a dedidcated git repository. Therefore, a user doc needs to be updated accordingly. Signed-off-by: Mike Sul <[email protected]>
Signed-off-by: Mike Sul <[email protected]>
19e694e
to
223d94b
Compare
Docs for 223d94b are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2706/docs/artifacts/html/index.html |
@detsch I've rebased it, and it is ready for review now. |
@kprosise It looks like the link check failure is not related to this PR changes https://ci.foundries.io/projects/fio-docs/builds/2706/link-check/artifacts/console.log? |
Yep. linkcheck has been failing on seemingly random links every time I've run it locally. I plan on addressing it tomorrow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
PR Template and Checklist
Please complete as much as possible to speed up the reviewing process.
Readiness and adding reviewers as appropriate is required.
All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.
Readiness
Overview
Why merge this PR? What does it solve?
Checklist
make linkcheck
.-s, --signoff
).-S, --gpg-sign
).Comments
Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.