README: Ansible section is outdated for the current pi-manager-template

Open Beginner friendly
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
ansible, python
Domain
documentation

Research direction

Start in the README's Ansible section and review the documented make ansible-up prerequisites and container workflow. Update the section to cover the .env values, remove the obsolete Python venv steps, explain running make deploy-all-engines in the Ansible container, add the Yocto warning, reorder cloning and configuration, and remove the empty verification bullet.

Written by the indexing model from the issue text.

Description

The Ansible section no longer matches pi-manager-template:

  • make ansible-up requires a .env file first (REPO_PATH, VAULT_PASSWORD_FILE, SSH_PRIVATE_KEY_FILE)
  • The Python venv step is useless: Ansible runs in its own container, and make deploy-all-engines must run inside that container shell
  • Add a strong warning: on a Yocto device, never run setup_pi.sh or init-one-engine (they use apt and target Pi OS)
  • Fix the section order: clone the repos before telling the reader to configure them, and remove the empty "Verify that we are in the venv" bullet
Dominant language
BitBake
Stars
1
Forks
2
Avg merge
21h 16m
Merged PRs (30d)
6

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyronear/pyro-yocto

All issues in pyronear/pyro-yocto

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.