From 66f1193f6ddb34a6d70358316ac26077ba1a9aed Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 16 May 2023 11:30:06 +0000 Subject: [PATCH] [UPD] README.rst --- module_analysis/README.rst | 44 +++++++++++-------- module_analysis/static/description/index.html | 39 ++++++++-------- 2 files changed, 43 insertions(+), 40 deletions(-) diff --git a/module_analysis/README.rst b/module_analysis/README.rst index 45f6a77b6..8102dd9a2 100644 --- a/module_analysis/README.rst +++ b/module_analysis/README.rst @@ -14,13 +14,13 @@ Module Analysis :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github - :target: https://github.com/OCA/server-tools/tree/15.0/module_analysis + :target: https://github.com/OCA/server-tools/tree/16.0/module_analysis :alt: OCA/server-tools .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-module_analysis + :target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-module_analysis :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png - :target: https://runbot.odoo-community.org/runbot/149/15.0 + :target: https://runbot.odoo-community.org/runbot/149/16.0 :alt: Try me on Runbot |badge1| |badge2| |badge3| |badge4| |badge5| @@ -35,22 +35,22 @@ This module can be usefull in the following cases : * To evaluate the amount to pay to odoo to upgrade your custom code, or the induced workload -.. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/installed_modules_by_types.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/installed_modules_by_types.png For that purpose, it adds new concepts * ``ir.module.author``, based on the value ``author`` present in the manifest file. -.. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_authors.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_authors.png * ``ir.module.type``, populated by default with Odoo and OCA values. -.. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_types.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_types.png Each installed modules have extra data in the 'Technical Data' tab : -.. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_form.png +.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_form.png **Table of contents** @@ -74,22 +74,20 @@ it information. This module comes with default rules. - .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/default_module_type_rules.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/default_module_type_rules.png You can add your custom rules to identify the modules your team have developped for exemple, - .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/add_module_type_rules.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/add_module_type_rules.png to update the data manually, you have to : -* Go to 'Apps' / 'Update Apps List' +* Go to 'Settings' / 'Technical' / 'Scheduled Actions' -* Check the box 'Analyse Installed modules' - - .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/base_module_update.png +* Run manually the action : 'Update Module Analysis' This will update analysis of your installed modules. @@ -97,7 +95,7 @@ to update the data automatically, you have to : * Go to 'Settings' / 'Technical' / 'Scheduled Actions' -* Configure the action 'Update Module Analysis'. (By default, the analysis will be done nightly) +* Configure the action 'Update Module Analysis' and activate it. (By default, the cron is unactive and no analysis is done) Adding Extra data @@ -130,7 +128,7 @@ Exclude files and directories Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters' 'System Parameters' : - .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/config_parameters.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/config_parameters.png The list of folders and filename will be exclude from the analysis. You can change the default settings. @@ -142,9 +140,9 @@ Usage Open the stats to analyse the detail of the code installed - .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pivot.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pivot.png - .. image:: https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pie.png + .. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pie.png Bug Tracker =========== @@ -152,7 +150,7 @@ Bug Tracker Bugs are tracked on `GitHub Issues `_. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -182,6 +180,14 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use. -This module is part of the `OCA/server-tools `_ project on GitHub. +.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px + :target: https://github.com/legalsylvain + :alt: legalsylvain + +Current `maintainer `__: + +|maintainer-legalsylvain| + +This module is part of the `OCA/server-tools `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/module_analysis/static/description/index.html b/module_analysis/static/description/index.html index a54431bdd..a320e247a 100644 --- a/module_analysis/static/description/index.html +++ b/module_analysis/static/description/index.html @@ -367,7 +367,7 @@ ul.auto-toc { !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

This module allows you to know ‘how much code’ is running on your Odoo instance, group by ‘Type’ (Odoo Core, OCA, other…)

This module can be usefull in the following cases :

@@ -377,19 +377,19 @@ instance, group by ‘Type’ (Odoo Core, OCA, other…)

  • To evaluate the amount to pay to odoo to upgrade your custom code, or the induced workload
    • -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/installed_modules_by_types.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/installed_modules_by_types.png

    For that purpose, it adds new concepts

    • ir.module.author, based on the value author present in the manifest file.
    -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_authors.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_authors.png
    • ir.module.type, populated by default with Odoo and OCA values.
    -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_types.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_types.png

    Each installed modules have extra data in the ‘Technical Data’ tab :

    -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/module_form.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/module_form.png

    Table of contents

      @@ -423,28 +423,23 @@ file. it information.

      This module comes with default rules.

      -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/default_module_type_rules.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/default_module_type_rules.png

      You can add your custom rules to identify the modules your team have developped for exemple,

      -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/add_module_type_rules.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/add_module_type_rules.png

      to update the data manually, you have to :

      -
        -

      • Go to ‘Apps’ / ‘Update Apps List’

        -
        • -

      • Check the box ‘Analyse Installed modules’

        -
        -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/base_module_update.png -
        -
        • +
          +
        • Go to ‘Settings’ / ‘Technical’ / ‘Scheduled Actions’
          • +
        • Run manually the action : ‘Update Module Analysis’

        This will update analysis of your installed modules.

        to update the data automatically, you have to :

        • Go to ‘Settings’ / ‘Technical’ / ‘Scheduled Actions’
          • -
        • Configure the action ‘Update Module Analysis’. (By default, the analysis will be done nightly)
          • +
        • Configure the action ‘Update Module Analysis’ and activate it. (By default, the cron is unactive and no analysis is done)

        Adding Extra data

        @@ -473,7 +468,7 @@ files), create a custom modules and overload the module model :

        Two parameters are availaible in ‘Settings’ / ‘Technical’ / ‘Parameters’ ‘System Parameters’ :

        -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/config_parameters.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/config_parameters.png

        The list of folders and filename will be exclude from the analysis. You can change the default settings.

        @@ -486,8 +481,8 @@ You can change the default settings.

      Open the stats to analyse the detail of the code installed

      -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pivot.png -https://raw.githubusercontent.com/OCA/server-tools/15.0/module_analysis/static/description/analysis_pie.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pivot.png +https://raw.githubusercontent.com/OCA/server-tools/16.0/module_analysis/static/description/analysis_pie.png
    @@ -495,7 +490,7 @@ You can change the default settings.

    Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed -feedback.

    +feedback.

    Do not contact contributors directly about support or help with technical issues.

    @@ -519,7 +514,9 @@ If you spotted it first, help us smashing it by providing a detailed and welcome

    OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

    -

    This module is part of the OCA/server-tools project on GitHub.

    +

    Current maintainer:

    +

    legalsylvain

    +

    This module is part of the OCA/server-tools project on GitHub.

    You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.