Skip to content

tutorials: general container-only fixes#896

Merged
mike-scott merged 2 commits intofoundriesio:mainfrom
vanmaegima:get-started-fix
Mar 6, 2026
Merged

tutorials: general container-only fixes#896
mike-scott merged 2 commits intofoundriesio:mainfrom
vanmaegima:get-started-fix

Conversation

@vanmaegima
Copy link
Member

@vanmaegima vanmaegima commented Mar 6, 2026

At this point, the user is not aware of how to configure new branches in a factory, so remove mentions to devel.
We should address creating new branches in a new tutorial, coming before Working with Tags.

Also handle the "Register Your Device" ambiguity based on the factory type.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.
You may delete items that are not relevant to your contribution.
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

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck, and add redirects for any moved or deleted pages.
  • 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.

@vanmaegima vanmaegima marked this pull request as draft March 6, 2026 12:42
@vanmaegima
Copy link
Member Author

Converted to draft as I will cover other topics raised by Mike in this PR

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, thanks for taking care of this!

@vanmaegima vanmaegima changed the title tutorials: remove mentions to devel branch in first tutorial tutorials: general container-only fixes Mar 6, 2026
@vanmaegima vanmaegima marked this pull request as ready for review March 6, 2026 14:44
Copy link
Contributor

@mike-scott mike-scott left a comment

Choose a reason for hiding this comment

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

Thank you for the quick fix @vanmaegima ! LGTM

Copy link
Contributor

@mike-scott mike-scott left a comment

Choose a reason for hiding this comment

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

Some text tweaks.

@vanmaegima
Copy link
Member Author

@mike-scott done

Copy link
Contributor

@mike-scott mike-scott left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. Looks great.

At this point, the user is not aware of how to configure new branches in a factory,
so remove mentions to ``devel``.

Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
Now that we support container-only factories, the registering process is specific for
the factory type.

We should point to both sources when mentioning the registered devices.

Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
@mike-scott mike-scott merged commit 796b4a8 into foundriesio:main Mar 6, 2026
1 of 3 checks passed
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