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 documentation on how to build images #2535

Merged
merged 5 commits into from
Dec 20, 2023

Conversation

reubenmiller
Copy link
Contributor

@reubenmiller reubenmiller commented Dec 19, 2023

Proposed changes

The following documentation changes are included:

  • Yocto build instructions using new meta-tedge-project (using kas)
  • Remove existing yocto build instructions (as these are very hard to maintain). In a follow up PR, the meta-rust variant of the image build will be added to the meta-tedge-project once a few technical problems have been resolved.
  • Rugpi build instructions
  • How to flash an image to an SD Card
  • How to onboard a device to Cumulocity (using auto detection via DNS Service Discovery which is built into the images)

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: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Dec 19, 2023
@reubenmiller reubenmiller self-assigned this Dec 19, 2023
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

This material deserves to be published along 1.0.rc.

Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Copy link
Contributor

github-actions bot commented Dec 20, 2023

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
373 0 3 373 100 57m0.881s

@reubenmiller reubenmiller merged commit 0bdd7d7 into thin-edge:main Dec 20, 2023
16 checks passed
@reubenmiller reubenmiller deleted the docs-build-images branch December 20, 2023 16:42
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants