Skip to content

missing documentation for packages #3131

@maurerle

Description

@maurerle

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.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    5. needs: documentationDocumentation is required before this changeset can be accepted

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions