docs: add missing packages and improve wifi configuration#3637
docs: add missing packages and improve wifi configuration#3637maurerle wants to merge 5 commits intofreifunk-gluon:mainfrom
Conversation
|
Many thanks for the work, for a voluntary community project it's so important to have good documentation, to understand but also to allow others to jump in if needed. For the SQM package I was wondering, does it "only" reduce latency / bufferbloat? Or could it also enable some fairness between streams? For example in a setup with three fully meshed nodes A, B, C, and C provides an uplink via fastd: Would each client device / client MAC address on A and B get the same bandwidth over the fastd tunnel? Or is that not possible yet, because CAKE is not capable to look inside the batman-adv header? (But could maybe also be discussed or added later, don't want to derail this PR.) |
8d95dc9 to
007ef67
Compare
|
There are still a few unresolved comments (2 of which Github had helpfully hidden...) - and I just unresolved one that I consider important. We can merge this after everything has been resolved and backport to 2025.1.x later. |
007ef67 to
e61844d
Compare
|
The open discussions are fixed now - so this should be good. |
docs/README.md
Outdated
| This is set up using: | ||
|
|
||
| 0. Create environment using `python -m venv .venv` | ||
| 1. Activate the environment using `source ./.venv/bin/activate` |
There was a problem hiding this comment.
This does not work. The venv must not be located inside the docs directory, or Sphinx will attempt to build parts of the venv as doc files.
There was a problem hiding this comment.
Also, using . instead of source is preferable, as it is compatible with more shells (. is POSIX shell, while source is a bash extension supported by many, but not all shells)
There was a problem hiding this comment.
Choosing a path like .venv and adding it to exclude_patterns in conf.py and .gitignore would be an option. Might just call it venv though, no need to hide it.
There was a problem hiding this comment.
I changed instructions to create the venv in the repo root - what do you think about this?
There was a problem hiding this comment.
This is how I've been building the docs usually, but it may be cleaner to provide a way to keep the venv in the docs directory (may also reduce confusion if we ever add another requirements.txt for a separate Python environment) - as mentioned, this would just require adding the designated venv directory to exclude_patterns.
Maybe _venv would be a good name then, to make it match other special directories like _build?
e61844d to
cbf0c2c
Compare
I hope that these changes are not too controversial.. :)
gluon-mesh-vpn-sqmgluon-wireless-encryption-wpa3closes #3131