-
Notifications
You must be signed in to change notification settings - Fork 120
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
Add a doc page about wifi #629
Conversation
Also link to FQ entry. see coreos/fedora-coreos-docs#629
Ideally, we should stop adding things to the FAQ as it's really hard to find them and for people to search for. As this is about networking, this should go into the existing Network Configuration page or another one dedicated to WiFi. |
yes. we have an outstanding action/todo for that page to exist. If @jbtrystram feels motivated he can add that page here too. Otherwise I think the FAQ is fine since we do have a search function in the docs and the FAQ entries are useful to link back to. |
modules/ROOT/pages/faq.adoc
Outdated
If NetworkManager-wifi is a requested layered package, a warning is | ||
displayed to encourage users to also add a wifi-firmware. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is a good place to mention the nuance of installing one versus all firwmares. any one system probably only needs one of the firmwares, but the tricky part is knowing which one.
So let's list some options here and then mention to them that if they don't know which one they need then just install them all. i.e.:
atheros-firmware
: # Firmware for Qualcomm Atheros WiFi/Bluetooth adaptersrealtek-firmware
: # Firmware for Realtek WiFi/Bluetooth adapters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how would all the firmware be installed ? I tried dnf install @hardware-support
in a toolbox but that didn't work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can list the ones we know about here in the instructions..
so we have the list.. then we say if you know the one you need then just:
rpm-ostree install --allow-inactive atheros-firmware
if you don't know the one you need then
rpm-ostree install --allow-inactive atheros-firmware realtek-firmware a b c d e f g
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, that's going to be a long command though.. I was hoping for a group-style thing I wasn't aware about :)
will update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, if you want to break it up to make it look better you can like this:
rpm-ostree install --allow-inactive \
atheros-firmware \
realtek-firmware \
...
Also link to FQ entry. see coreos/fedora-coreos-docs#629
e18d65b
to
aa49ebd
Compare
Also link to FQ entry. see coreos/fedora-coreos-docs#629
looking good! once we get the last package removed from that list we can merge. does it look good when you render the docs site locally? |
ok I spoke too soon :) I see now that you have converted this into not a FAQ entry, but a standalone page. I think you are trying to address coreos/fedora-coreos-tracker#862 (comment) which is awesome! but... I think doing that will require more work here. We need to address more than just the missing firmware. We need to give some background on our stance on Wifi in general and then explain what to do to enable it. If you want I can take a crack at this and push a commit up to this PR. |
You definitely know more context than me there, so if you have the time that would be awesome |
Some wifi-firmwares will be split into sub-packages in fedora 40 We will keep them in until fedora 41, but display a warning message in the console. This messages links to this FAQ entry. See coreos/fedora-coreos-config#2963 See coreos/fedora-coreos-tracker#1575
modules/ROOT/pages/wifi.adoc
Outdated
@@ -0,0 +1,66 @@ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
modules/ROOT/pages/wifi.adoc
Outdated
== How do I add the missing wifi-firmwares? | ||
|
||
Some wifi-firmwares will be split into sub-packages in Fedora 39 and Fedora 40. | ||
Fedora Cores OS will keep them in until Fedora 41, but display a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The styling convention for asciidoc is one sentence per line.
This reduces the amount of diff while keeping things readable.
See: https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This /lgtm as is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ✔️
ok I added a commit here that adds more context to the documentation page and then splits out the pieces about the wifi firmware dropping into a FAQ entry again. |
Now we have a generic wifi enablement docs page and a FAQ entry that explains the specific situation we have now where the firwmare subpackages are getting dropped out of FCOS.
Also link to FQ entry. see coreos/fedora-coreos-docs#629
Also link to FQ entry. see coreos/fedora-coreos-docs#629
Some wifi-firmwares will be split into sub-packages in fedora 40 We will keep them in until fedora 41, but display a warning message in the console if NetworkManager-wifi is layered without the most popular the wifi firmwares. See coreos/fedora-coreos-tracker#1575 Also link to FAQ entry. see coreos/fedora-coreos-docs#629
Some wifi-firmwares will be split into sub-packages in fedora 40 We will keep them in until fedora 41, but display a warning message in the console if NetworkManager-wifi is layered without the most popular the wifi firmwares. See coreos/fedora-coreos-tracker#1575 Also link to FAQ entry. see coreos/fedora-coreos-docs#629
Thanks @jbtrystram and @dustymabe for the work on the docs here |
Some wifi-firmwares will be split into sub-packages in fedora 40 We will keep them in until fedora 41, but display a warning message in the console. This messages links to this FAQ entry.
See coreos/fedora-coreos-config#2963 See coreos/fedora-coreos-tracker#1575