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

Update docs #2216

Merged

Conversation

add "Workaround for network related features on bookworm"
harmonize and update description / message
@AlvinSchiller AlvinSchiller requested review from pabera and s-martin and removed request for pabera January 16, 2024 23:43
as alerts are not supported inside of "details"
installation/install-jukebox.sh Outdated Show resolved Hide resolved
installation/install-jukebox.sh Outdated Show resolved Hide resolved
documentation/builders/installation.md Show resolved Hide resolved
AlvinSchiller and others added 3 commits January 17, 2024 01:14
Co-authored-by: s-martin <s-martin@users.noreply.github.com>
@coveralls
Copy link

coveralls commented Jan 17, 2024

Pull Request Test Coverage Report for Build 7638766854

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
To ensure accuracy in future PRs, please see these guidelines.
A quick fix for this PR: rebase it; your next report should be accurate.

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 38.384%

Totals Coverage Status
Change from base Build 7539106538: 0.0%
Covered Lines: 418
Relevant Lines: 1089

💛 - Coveralls

documentation/builders/installation.md Outdated Show resolved Hide resolved
@pabera pabera added future3 Relates to future3 development documentation labels Jan 17, 2024
@pabera pabera added this to the v3.5 milestone Jan 17, 2024
<details>
With Bookworm the network settings have changed. Now "NetworkManager" is used instead of "dhcpcd".
This breaks breaks network related features like "Static IP", "Wifi Setup" and "Autohotspot".
Before running the installation, the network config has to be changed via raspi-config, to use the "old" dhcpcd network settings.
Copy link
Collaborator

Choose a reason for hiding this comment

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

If we refer to use Bullseye, this is not a problem anymore.
Meanwhile, can't we just automate this instead of describing it here, potentially loosing builders along the way? We could silently change the raspi-config in the installation, most builders won't care. It's a save convention to define.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We could keep this docs for reference on Bookworm, but it'll be less of a pain for most builders.

Copy link
Collaborator Author

@AlvinSchiller AlvinSchiller Jan 17, 2024

Choose a reason for hiding this comment

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

Our current installation instruction dont mention a specific version (the default will be select be RPI Imager), but i think more and more will use the newer Bookworm, and running into this.

A quickfix in the installation is not possible, as a change of the setting will instantly reset the network and the user will lose access to the device, if it has a wifi connection.

I address the problem, with #2184 to have both ways working.
So this is just a temporary documentation apart from the Issue and notes in the Release till the implementation is finished ( in case it will not be ready for 3.5.0 ).

documentation/builders/installation.md Outdated Show resolved Hide resolved
@pabera pabera mentioned this pull request Jan 17, 2024
13 tasks
@@ -19,6 +18,8 @@
* [OnOff SHIM for safe power on/off](./components/power/onoff-shim.md)
* [Soundcards](./components/soundcards/)
* [HiFiBerry Boards](./components/soundcards/hifiberry.md)
* [Synchronisation](./components/synchronisation/)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is it ok to add all components here, or do we need to split this for hardware and software implementations?

Copy link
Collaborator

Choose a reason for hiding this comment

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

For better readability, I would split that.

Copy link
Collaborator

Choose a reason for hiding this comment

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

As soon as this list grows, we can slit it. I like the idea

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How about splitting it now and restructure a bit.
In my opinion its not really clear what the different headers mean (config, components, advanced).

Idea for restructuring:
Additionally i would suggest to add the rfid reader docs for supported readers. Maybe even move to builder space (except mock and template)?

Bildschirmfoto 2024-01-24 um 08 37 39

documentation/builders/README.md Show resolved Hide resolved
documentation/builders/samba.md Outdated Show resolved Hide resolved
documentation/builders/samba.md Outdated Show resolved Hide resolved
AlvinSchiller and others added 2 commits January 24, 2024 08:56
Co-authored-by: s-martin <s-martin@users.noreply.github.com>
@AlvinSchiller AlvinSchiller merged commit f6db160 into MiczFlor:future3/develop Jan 24, 2024
21 checks passed
@AlvinSchiller AlvinSchiller deleted the future3/fix/updatedocs branch January 24, 2024 22:19
@AlvinSchiller AlvinSchiller mentioned this pull request Jan 30, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation future3 Relates to future3 development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants