Skip to content

Help Popup module evolution #103

Closed
Closed

Description

@bealdav

This PR OCA/web#417
propose a way to aggregate help content by model or action

Help popup module

Pros

  • several modules can put their doc content on the same object with the same field
  • end users can be see contextual doc of several modules
  • end users can add/replace some parts of the doc
  • documentation can be aggregated for a whole menu (Sales, Accounting ...) and be extended to the whole ERP.

Cons / Todo

  • help fields (which store content) are in ir.model and ir.act_window: easy but not fine for security rules ?
  • no way to reuse customized parts of doc provided by endusers
  • no use of qweb then doc inherits impossible: only add some parts.
  • no interaction between modules in knowledge repos and this module (changes approval, etc.)

Activity

  1. max3903 commented on Oct 11, 2016

    @max3903
    SponsorMember

    Related issues:

    As discussed, I propose:

    • to use document.page to store content
    • your module (web_help in OCA/web) to have a relationship with window action or model and to display it in the backend
    • website_help in OCA/website to display it on the website (as a public wiki)
  2. hbrunn commented on Mar 28, 2017

    @hbrunn
    Member

    I'm busy with help_popup_document_page, which should do most of the above

  3. added a commit that references this issue on Mar 29, 2017
    59271b3
  4. SalahAdDin commented on Dec 11, 2018

    @SalahAdDin
    Contributor

    @hbrunn looks great!!!

  5. added a commit that references this issue on Jun 6, 2019
    ea811f8
  6. etobella commented on Jul 15, 2020

    @etobella
    Member

    Is this still relevant? @bealdav

  7. bealdav commented on Jul 15, 2020

    @bealdav
    MemberAuthor

    I never took time to port my initial module. I don't know if it so useful for a large public.

    It's the problem with OCA we don't know who use our modules.

  8. github-actions commented on Aug 14, 2022

    @github-actions

    There hasn't been any activity on this issue in the past 6 months, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 30 days.
    If you want this issue to never become stale, please ask a PSC member to apply the "no stale" label.

  9. added
    stalePR/Issue without recent activity, it'll be soon closed automatically.
    on Aug 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions