Skip to content

doc: add a guide on getting started using configuration files#207

Open
johanehnberg wants to merge 8 commits intoraspberrypi:masterfrom
johanehnberg:doc/gettingstarted
Open

doc: add a guide on getting started using configuration files#207
johanehnberg wants to merge 8 commits intoraspberrypi:masterfrom
johanehnberg:doc/gettingstarted

Conversation

@johanehnberg
Copy link
Copy Markdown

@johanehnberg johanehnberg commented Mar 12, 2026

WIP tasks

  • Set the file location and if in root add a link in README or in doc add it to the ToC accordingly
  • Augment the guide with something common and simple yet descriptive. For example defining a one-liner command in the config that runs on target to install camera/AP/sensor. Settled on SSH and wifi.
  • Fix code snippet definitions sh->yaml for yaml files
  • Test everything before removing WIP

Ideas for minimizing caveats and guide length outside the scope of this PR:

Closes: #206

@learmj
Copy link
Copy Markdown
Collaborator

learmj commented Mar 12, 2026

Hi @johanehnberg Let's just keep it all in one 'getting started' doc. Myself and others plus external / community will review it when it has content.

@johanehnberg
Copy link
Copy Markdown
Author

@learmj OK. If the general structure of the document sits well with the project, all I need is a good, common case to use in the example. Preferably something that helps people install their own app/assets/file and run a command, but the working example only needing one such line each.

@learmj
Copy link
Copy Markdown
Collaborator

learmj commented Mar 12, 2026

@learmj OK. If the general structure of the document sits well with the project, all I need is a good, common case to use in the example. Preferably something that helps people install their own app/assets/file and run a command, but the working example only needing one such line each.

Sounds good. If you're basing it on your own use / experience, that would serve others well.

@johanehnberg
Copy link
Copy Markdown
Author

I added wifi station config as the simplest use case that we also have. It seems to have been requested so this may work as a stop-gap solution at least until a layer may be created. Considering the simplicity, I created #208 to allow streamlining much of this.

@johanehnberg johanehnberg changed the title WIP: doc: add a guide on getting started using configuration files doc: add a guide on getting started using configuration files Mar 14, 2026
@johanehnberg johanehnberg marked this pull request as ready for review March 14, 2026 18:42
@johanehnberg
Copy link
Copy Markdown
Author

Ready for review. The guide is a bit longer than what I aimed for, but as the tool matures and built-in layers get added, it can be shortened. The contents are now such that would have saved me a lot of hours when I started.

Copy link
Copy Markdown

@jaysephjw jaysephjw left a comment

Choose a reason for hiding this comment

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

Stumbled across this as I was looking at the project for the first time - and found it quite helpful!

Just a couple comments as I tried it.

----
mkdir -p myproject/bdebstrap
echo -e 'ClientAliveInterval 60' > myproject/sshdkeepalive.conf
echo -e '#!/bin/bash\n\nset -eu\n\nchroot $1 sh -c "apt-get -y install network-manager"\nchroot $1 sh -c "nmcli --offline connection add type wifi ssid $SSID wifi-sec.psk $PSK wifi-sec.key-mgmt wpa-psk > /etc/NetworkManager/system-connections/$SSID.nmconnection"\nchroot $1 sh -c "chmod 600 /etc/NetworkManager/system-connections/$SSID.nmconnection"' > myproject/bdebstrap/customize90-myscript
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

had to populate bdebstrap first

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

The second echo should do that as it is, but let me know if something else related was needed?

@learmj
Copy link
Copy Markdown
Collaborator

learmj commented Mar 18, 2026

Hi @stu-spp @martinn-ronin
As users who have previously indicated a preference for some intro documentation, how does this look to you?

Hi @johanehnberg I'd prefer to wait on getting some user / community feedback before merging. Thanks again for your efforts.

@johanehnberg
Copy link
Copy Markdown
Author

Thanks @jaysephjw for the feedback! All fixed.

@stu-spp
Copy link
Copy Markdown

stu-spp commented Mar 18, 2026

This looks great! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make learning curve more gentle (PR contribution offer)

4 participants