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: update rugpi instructions to align with rugpi v0.6 #2668

Merged

Conversation

reubenmiller
Copy link
Contributor

Proposed changes

Update rugpi image building instrustions after refactoring the tedge-rugpi-image repo to use new Rugpi features (layers and repositories) introduced in 0.6.

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

@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:firmware labels Feb 5, 2024
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.

Not related to the docs, but testing while reading, I got the following error:

$ just build-pi4

Error: loading library

Caused by:
    0: error reading recipe info from path `"/project/recipes/sbom/recipe.toml"
    1: No such file or directory (os error 2)

```

:::tip
This step is critical as it will enable you to connect via SSH to your device to perform tasks such as onboarding! If you don't set your ssh public key in the authorized keys, you then need to connect your device to a monitor/display and keyboard in order to perform the onboarding.
:::

3. Commit the changes
4. Optional: Add Wifi ssid/password - only required for the initial flashing of the device
Copy link
Contributor

Choose a reason for hiding this comment

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

"only required for the initial flashing of the device"

I don't fully get this note. This Wifi setting will be used by the device once flashed, not only for the first boot of the image. Isn't it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay I saw, the note below. The note should be enough.

Suggested change
4. Optional: Add Wifi ssid/password - only required for the initial flashing of the device
4. Optional: Add Wifi ssid/password

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed. Resolved by be3aebc

@didier-wenzek
Copy link
Contributor

Not related to the docs, but testing while reading, I got the following error:

$ just build-pi4

Error: loading library

Caused by:
    0: error reading recipe info from path `"/project/recipes/sbom/recipe.toml"
    1: No such file or directory (os error 2)

This error was unrelated. But because I reused a clone with remaining recipes from the old version.

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

Copy link
Contributor

github-actions bot commented Feb 5, 2024

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
390 0 3 390 100 59m12.154999999s

@reubenmiller reubenmiller added this pull request to the merge queue Feb 5, 2024
Merged via the queue into thin-edge:main with commit b688538 Feb 5, 2024
18 checks passed
@reubenmiller reubenmiller deleted the docs-update-rugpi-instructions branch July 18, 2024 13:34
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.

2 participants