[improvement] Custom command documentation

[cbeaujoin-stellar]

Currently there is 3 part of the documentation about custom commands:

• https://openwisp.io/docs/dev/controller/user/shell-commands.html#defining-new-options-in-the-commands-menu
• https://openwisp.io/docs/dev/controller/developer/utils.html#registering-unregistering-commands
• https://openwisp.io/docs/dev/controller/user/settings.html#openwisp-controller-user-commands

Second is linked to the third and third to the first, but no reference in the first.

Maybe a Note with a link should be added in the first one.

[nemesifier]

@cbeaujoin-stellar I am not 100% I understood your point.

Are you point out to the fact that something is missing from the https://openwisp.io/docs/dev/controller/user/shell-commands.html page?

From what I can see, the OPENWISP_CONTROLLER_USER_COMMANDS setting is mentioned but not linked, while the https://openwisp.io/docs/dev/controller/developer/utils.html#registering-unregistering-commands is linked in the last section.

What do you think is missing exactly, can you be more specific please?

[cbeaujoin-stellar]

Hello,
Exactly just reference the https://openwisp.io/docs/dev/controller/developer/utils.html#registering-unregistering-commands into https://openwisp.io/docs/dev/controller/user/shell-commands.html

[nemesifier]

@cbeaujoin-stellar it is mentioned and linked in the last section of the page: https://openwisp.io/docs/dev/controller/user/shell-commands.html#how-to-register-or-unregister-commands, it's kept separate because it's meant to be used by developers, while the configuration setting allows to define commands through configuration, without the need to change any code, the two methods of defining new commands are meant for different audiences:

• config setting: users who aren't extending openwisp
• register functions: developers who are implementing new django apps which extend and customize the behavior of openwisp

Is this clear? I hope it helps. If I misunderstood you let me know.

[cbeaujoin-stellar]

Hello,

yes you understood well. I agree that both are fore different audience, but as developer while looking about adding custom commands, I first found this page https://openwisp.io/docs/dev/controller/user/shell-commands.html .

As the way the configuration is done is in fact kind of coding, I didn't expect to have a better way to implement my custom commands.

I found out about it while reverse engineer/debugging/testing the code, then finally I find out about the documentation for developers who are extending. I think it would have save time to me if a link has been added in https://openwisp.io/docs/dev/controller/user/shell-commands.html

Something like:
Hey, know what? If you're extending Controller you can directly register your custom commands this way [ link ]