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

[docs] Comprehensive/Unified Documentation Website #107

Closed
nemesifier opened this issue May 18, 2020 · 2 comments · Fixed by #189
Closed

[docs] Comprehensive/Unified Documentation Website #107

nemesifier opened this issue May 18, 2020 · 2 comments · Fixed by #189
Labels

Comments

@nemesifier
Copy link
Member

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:

  • user documentation (quickstart, guides, explanation of features)
  • developer (information for developers and contributors)
  • general (project goals, values, press, etc)

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:

# user:
/openwisp-controller/docs/user
/openwisp-controller/docs/user/feature1
/openwisp-controller/docs/user/feature2
# docs:
/openwisp-controller/docs/developer
/openwisp-controller/docs/developer/setup
/openwisp-controller/docs/developer/extending

The Makefile will take each module user and developer directory and copy the files as follows:

cp /openwisp-controller/docs/user/* /openwisp2-docs/user/openwisp-controller/
cp /openwisp-controller/docs/developer/* /openwisp2-docs/developer/openwisp-controller/
@pandafy
Copy link
Member

pandafy commented Feb 16, 2024

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.

@nemesifier
Copy link
Member Author

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

pandafy added a commit to pandafy/openwisp2-docs that referenced this issue Apr 17, 2024
@nemesifier nemesifier changed the title [docs] Comprehensive documentation [docs] Comprehensive/Unified Documentation Website May 31, 2024
nemesifier added a commit to openwisp/ansible-openwisp2 that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-controller that referenced this issue Aug 3, 2024
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.
nemesifier added a commit to openwisp/docker-openwisp that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-firmware-upgrader that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-ipam that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-monitoring that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-network-topology that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-notifications that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-config that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwrt-openwisp-monitoring that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-wifi-login-pages that referenced this issue Aug 3, 2024
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>
nemesifier added a commit to openwisp/openwisp-users that referenced this issue Aug 3, 2024
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.
nemesifier added a commit to openwisp/openwisp-utils that referenced this issue Aug 3, 2024
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>
Dhanus3133 pushed a commit to openwisp/openwisp-notifications that referenced this issue Aug 21, 2024
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>
@nemesifier nemesifier moved this to Done in Roadmap Aug 21, 2024
praptisharma28 pushed a commit to openwisp/openwisp-controller that referenced this issue Sep 9, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
3 participants