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

Custom sota dedicated repo #723

Merged
merged 2 commits into from
Jul 31, 2024
Merged

Custom sota dedicated repo #723

merged 2 commits into from
Jul 31, 2024

Conversation

mike-sul
Copy link
Contributor

@mike-sul mike-sul commented Jul 10, 2024

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

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • 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 Jul 10, 2024

@doanac
Copy link
Member

doanac commented Jul 10, 2024

@@ -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]
Copy link
Member

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)

Copy link
Contributor Author

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
Copy link
Member

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?

Copy link
Contributor Author

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.

@doanac
Copy link
Member

doanac commented Jul 12, 2024

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]>
@doanac
Copy link
Member

doanac commented Jul 25, 2024

@mike-sul mike-sul marked this pull request as ready for review July 25, 2024 13:19
@mike-sul
Copy link
Contributor Author

@detsch I've rebased it, and it is ready for review now.

@mike-sul mike-sul requested a review from kprosise July 25, 2024 13:23
@mike-sul
Copy link
Contributor Author

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

@kprosise
Copy link
Contributor

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

Copy link
Member

@detsch detsch left a comment

Choose a reason for hiding this comment

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

LGTM

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.

LGTM

@kprosise kprosise merged commit f8e6b48 into main Jul 31, 2024
3 of 4 checks passed
@kprosise kprosise deleted the custom-sota-dedicated-repo branch July 31, 2024 10:59
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.

4 participants