Skip to content

docs: add link to official yocto quick guide#2877

Closed
Ruadhri17 wants to merge 1 commit intothin-edge:mainfrom
Ruadhri17:update-yocto-docs
Closed

docs: add link to official yocto quick guide#2877
Ruadhri17 wants to merge 1 commit intothin-edge:mainfrom
Ruadhri17:update-yocto-docs

Conversation

@Ruadhri17
Copy link
Copy Markdown
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>
## 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
Copy Markdown
Contributor

@reubenmiller reubenmiller May 15, 2024

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 Theme: Firmware update topics 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
@reubenmiller
Copy link
Copy Markdown
Contributor

Closing in favor of #3298. I've included the warning by using a simple copy/paste (sorry I didn't move the commit).

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 Theme: Firmware update topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants