[IMP] help_online and help_popup should be merged.

[nhomar]

Both modules has interesting concepts and basically the same bad things.

I did something like this concepts for v7.0 and I think the concept is almost mandatory, then to bring back a strong solution I propose:

• From help_online the concept of a functional user editing the help is cool.
• From help_popup the concept of mnantain original help, technical help and functional help is good.
• We can have 2 modules compliimentary help_online which add the button with a pretty fontoawesome icon to respect the iconography of odoo and a website_help_online which add the edit inline feature.
• Propose read the doc/index.rst file to prefill the documentation (odoo already mange this elements for apps, we should take that approach.
• Make a proper PR and open the discussion.
• For compatibility issues we should not delete the original ones until a proper survey to ensure not brake compatibility inside the same stable version.

This is a basic TODO list if original creators @rvalyi and @lmignon think different this is an open issue to start the discussion or may be they have strongest ideas to put here and may be already started the job.

[lmignon]

@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

[dreispt]

@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.

[nhomar]

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.

[nhomar]

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.

[lmignon]

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

[dreispt]

@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?

[lmignon]

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

[dreispt]

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.

[nhomar]

@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

[pedrobaeza]

Are you going to work on this on OCA?

[pedrobaeza]

No answer, so I close.