-
Notifications
You must be signed in to change notification settings - Fork 66
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
[docs] Comprehensive/Unified Documentation Website #107
Comments
We would also need to handle the versioning of the docs. E.g. OpenWISP v22 should show documentations from V1.0 of openwisp modules and v23 should show documentation from v1.1 It should be possible to map documentation OpenWISP version to modules version. |
We are actively working on this task, anybody interested in collaborating, reviewing the docs, giving us feedback, please get in touch in the developer chat on matrix/gitter: https://matrix.to/#/#openwisp_development:gitter.im |
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107.
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Signed-off-by: Abdur Rehman <abdur.rehman@linux.com> Co-authored-by: Federico Capoano <f.capoano@openwisp.io> Co-authored-by: Abdur Rehman <abdur.rehman@linux.com>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107.
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107. --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
Restructured the documentation in a way that allows it to be included in the Unified Documentation of OpenWISP. For more information see openwisp/openwisp-docs#107.
We need a comprehensive documentation which describes all the modules.
I want to avoid having the documentation of each module contained in this repo because that would make it harder to maintain: if we keep the documentation of each module in the module itself, we will be able to always request contributors to document their work because it will be easy for them.
We could use a system of git submodules, each OpenWISP module will be a submodule in this repo and we'll have some scripts which will glue everything together and generate the sphinx documentation.
The documentation could be divided as follows:
The user and developer sections will then have one sub-directory for each module, or something similar.
Each module could have a structure like the following:
The
Makefile
will take each moduleuser
anddeveloper
directory and copy the files as follows:The text was updated successfully, but these errors were encountered: