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

docs: add link to official yocto quick guide #2877

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ruadhri17
Copy link
Contributor

Proposed changes

Host requirements can change with different Yocto release or when using different host OS. To make sure user can be more up-to-date with Yocto changes, I added link to official Yocto quick guide.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: Krzysztof Piotrowski <krzysztof.piotrowski@inetum.com>
@@ -17,6 +17,10 @@ Whilst the methodology described on this page can be extended to support other d

## Setting up your build system

:::info
The instructions below were tested with the `kirkstone` release. If you want to use a different project version or check the most recent requirements, visit [Official Yocto quick guide](https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html). Make sure you select the proper release, as the instructions may vary for different versions.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this statement goes far enough to highlight the importance of matching the yocto version that is supported by the meta-tedge-projects. The rewording won't be trivial, but I'll give it a shot soon.

@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:firmware labels May 15, 2024
@reubenmiller reubenmiller changed the title docs(yocto): add link to official yocto quick guide docs: add link to official yocto quick guide Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation theme:firmware
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants