void-docs
void-docs copied to clipboard
void-linux
Update wpa_supplicant.md
add details on how to use wpa_cli and wpa_supplicant based on my reading experience and real life experiment on this doc.
At least enabling the service is redundant, users should refer to the linked page if they don't know how services are enabled, otherwise we would have a copy of ln -s foo bar on every page.
sv start is also not necessary as enabled services are always started unless they have a down file.
@Duncaen does it mean once the soft link happens the runit will run the service immediately?
As a new user who is referring to the doc during instillation, it is a bit easier to have all information needed in the front, especially for the networking setup. And I found void-installer cannot do this for me (wireless-setup) if I don't enable the wpa_supplicant service first.
@Duncaen does it mean once the soft link happens the runit will run the service immediately?
Yes it will start as soon as the service directory is scanned, which should happen within 5 or 14 seconds not sure, in this period, sv start won't work because the service is not scanned and can't be controlled with sv anyways.
Regarding the new update, this is exactly why this should be documented in the appropriate file, now we would have to duplicate a lot more text over all pages that enable a service, which doesn't really make it better.
@Duncaen Sure. I think the the time delay need to be mentioned . And using sv start to verify the change will be more deterministic.
Yes but the right place would be https://docs.voidlinux.org/config/services/index.html#enabling-services and not every single page that wants you to enable a service, linking to that page should be sufficient for new users who don't know how to enable services.
A little bit of redundancy is not bad at all. Just referring the general enabling services section does not solve the problem of specific service, i.e I have to look up the correct name of service file/directory. Giving the right command up front would be so much easier. Especially referring to my experience when I cannot get Internet access in void installation and starting to search the Internet, find if I am missing wifi firmware etc. And in void-installer shell, there is not auto-completion of directory and filenames.
We've decided that redundancy is just hurting maintainability and reading experience, exactly this example was discussed and is mentioned in the style guide:
Command code-blocks should not be used to describe routine tasks documented elsewhere in this Handbook. For example, when writing documentation for the foo package, do not provide a command code-block stating that one should install it via xbps-install foo. Similarly, do not provide code blocks describing how to enable the foo service.
https://github.com/void-linux/void-docs/blob/master/CONTRIBUTING.md#general
@Duncaen I don't think it hurts reading experience since it provides whatever information is needed by a reader who is looking for the exact command. But I don't want to spend time on arguing thus removing the ln command.
A little bit of redundancy is not bad at all. Just referring the general enabling services section does not solve the problem of specific service, i.e I have to look up the correct name of service file/directory.
This could be made clearer, but whenever we say "enable service_name service", the directory is named service_name.
Especially referring to my experience when I cannot get Internet access in void installation and starting to search the Internet, find if I am missing wifi firmware etc.
New images will hopefully include the void-docs package, allowing you to access the documentation even when offline.
And in void-installer shell, there is not auto-completion of directory and filenames.
Is it running dash? We can probably add a note to the installation section about switching to bash before doing anything complicated.
