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.

Sign up for GitHub

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

Jump to bottom

DOCS-3152: Clarify info about preinstall script #3704

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

DOCS-3152: Clarify info about preinstall script #3704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/how-tos/provision-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ If you created a <FILE>viam-provisioning.json</FILE>, specify its location when

You must have flashed a 64-bit image to your SD card and customized at least the hostname when prompted by the Raspberry Pi Imager.

Any customizations for the image must be applied in the RPi Imager tool when creating the SD card.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@Otterverse I don't know if this is even needed. Are there other customizations aside from what we say in the next line?

Copy link
Member

Choose a reason for hiding this comment

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

So the wording was already here (I mean, it's literally the two paragraphs below this.) But apparently people were still overlooking this and running into problems. So the request was to somehow make it even MORE obvious that customization is REQUIRED.

I'm not sure exactly what that looks like. Maybe a screenshot from the RPi Imager's dialog about customization and the "yes" button circled/highlighted? Maybe just some red highlights on the next below or the word "customized" in the paragraph or two above.

When you customize the hostname or other settings, the Raspberry Pi Imager creates `firstrun.sh` which is required to set up provisioning.

If you do not customize anything, `firstrun.sh` is not present on the device and the `preinstall.sh` script fails.
Expand Down
Loading