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

missing documentation for packages #3131

Open
10 of 12 tasks
maurerle opened this issue Dec 31, 2023 · 0 comments
Open
10 of 12 tasks

missing documentation for packages #3131

maurerle opened this issue Dec 31, 2023 · 0 comments

Comments

@maurerle
Copy link
Member

maurerle commented Dec 31, 2023

As mentioned on the gluon meetup at the 37c3, the documentation of available gluon features/packages is currently missing for the following packages:

Defined in https://gluon.readthedocs.io/en/latest/user/site.html#feature-flags

  • web-advanced
  • web-wizard

Defined here: https://gluon.readthedocs.io/en/latest/features/vpn.html#mesh-vpn-wireguard

  • mesh-vpn-wireguard

Defined here: https://gluon.readthedocs.io/en/latest/features/private-wlan.html#private-wlan

  • web-private-wifi
  • wireless-encryption-wpa3 (i think this deserves a separate section in packages/features?)

not defined at all:

There are others which are probably unused like gluon-mmfd, gluon-alfred and gluon-iptables-clamp-mss-to-pmtu, which I suspect to be unused..?
And there are also a lot of other packages which are already documented, not listed here.

I do not really know where to drawe the line between packages and features - so what should go into
https://github.com/freifunk-gluon/gluon/tree/master/docs/features
and what should go into
https://github.com/freifunk-gluon/gluon/tree/master/docs/package

I can draft something if this is considered a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant