How to properly document the scripts, aliases and practice we use for a specific robot setup

[S-Dafarra]

When working on a specific robot setup, we often end up writing some scripts or aliases to ease its usage.
Just to give an example, for iCubGenova04 and iCubGenova09 we use some alias to quickly go to the corresponding robots-configuration folder and to install the files, or to connect to the Bluetooth joystick.

While these may help the users that use these setups daily, it might not be trivial for people in the support team.

I wonder if there could be a commonly known location to store some "How To"s, "Tips and tricks" or similar.

cc @pattacini @vtikha @DanielePucci @traversaro @maggia80 @violadelbono @kouroshD @GiulioRomualdi @prashanthr05

[pattacini]

Hi @S-Dafarra

Don't you have some wiki/webpages you have been maintaining within your group (maybe on https://github.com/dic-iit) that could serve to publish such information?

If yes, the support team can consult that documentation when in need.

[pattacini]

@S-Dafarra to continue discussing the use of Bazaar, maybe icub-tech-iit/appsAway turns to be a better place.

[pattacini]

You may want to link back here the issue then.

[vtikha]

Yes, please go ahead in appsAway and we can discuss to create a section that can fit the above requirements such as the one done for the configuration-reports. Maybe even a generic documentation entry.

Sorry for the late reply

[vtikha]

During our discussions and various interactions with @S-Dafarra @giovannipizzolante, we decided to go ahead with the use of custom fields that can be added by the user. The user can add multiple fields as one would in a wiki or an issue composed in markdown. These customizable fields appear at the end of all the other sections, while in editing mode the customization appears as a new section which includes the possibility to add, modify or delete these newly added fields.

Here is a simple example to show the outcome/formatting:

[pattacini]

Looks awesome!