[IMP] help_online and help_popup should be merged. about web HOT 11 CLOSED

@nhomar When building a solution for a client, the documentation to provide is the final one IOW it must describe how the user can do its job with the apps.

Propose read the doc/index.rst file to prefill the documentation (odoo already mange this elements for apps, we should take that approach.

In the final solution, it's common to have a lot of modules assembled to cover the needs of the client. Therefore, there are no proper way to merge the doc provided by each modules individually in a user readable form. The goal behind 'help_online' is to provide a tool to functional users to write the doc in a wysiwyg way by taking benefits from the website editor. Do you have seen that the module provides a way to import/export the written documentation?

We can have 2 modules compliimentary help_online which add the button with a pretty fontoawesome icon

The icon used comes from fontoawesome

from web.

@nhomar The point for help_popup is to not he the website dependency, and that's why both exist.
Maybe they should be named web_help and website_help...

Other than that (different content editing strategy), I agree features provided should tend to be the same for both. Not easy but maybe website_help could be written as an extension for web_help.

from web.

Other than that (different content editing strategy), I agree features provided should tend to be the same for both. Not easy but maybe website_help could be written as an extension for web_help.

@dreispt exactly that's what I tried to say.

from web.

In the final solution, it's common to have a lot of modules assembled to cover the needs of the client. Therefore, there are no proper way to merge the doc provided by each modules individually in a user readable form. The goal behind 'help_online' is to provide a tool to functional users to write the doc in a wysiwyg way by taking benefits from the website editor. Do you have seen that the module provides a way to import/export the written documentation?

@lmignon Absolutly agreed.
But we can have a first approach for the doc and a section for the customized part.

That concept the module from akretion is respecting it perfectly, techincal section / odoo section / functional section / and.... integaration section.

You module is really cool but IMHO both modules are overlapping functional conceptps but they are complimentary.

from web.

@nhomar Curious to see how it's possible to assemble documentation on the same model provided by 2 different modules?

from web.

@lmignon not possible, but the "vision" is that website could be seen as an upgrade path for web module. Maybe some sort of migration scripts could be added?

from web.

@dreispt Sorry but I don't understand what you say.

from web.

I mean that, ideally, websitewould depend on web and it would provide a migration for the web help content to the website format.
From the end user side, they almost wouldn't notice the difference.
From the content creator side, it would just be that the content authoring engine is different.

from web.

@lmignon I am retaking this topic.

You are right about that is not necesary the help on the module itself being proposed, that should be in a section (original help) or something like that, but not part of this topic now.

You can find some improvements being done here:

Vauxoo#3

from web.

Are you going to work on this on OCA?

from web.

No answer, so I close.

from web.