Openbravo Forge End of Life Notice

Dear Openbravo Forge User,

Because of continued very low usage we decided to stop the following services on 31st of August 2017:

In case of question: webmaster "at" openbravo.com
View source | Discuss this page | Page history | Printable version   

Openbravoforgesupport/Help/Usage Openbravo Modules

Contents

Introduction

This document details the usage of the Forge for Openbravo modules.

Scope

By Openbravo modules we mean modules developed and maintained by Openbravo developers.

The following are NOT Openbravo modules:

  1. Extension modules developed by third-party developers. These modules have to follow instructions given at http://forge.openbravo.com/plugins/mwiki/index.php/Openbravoforgesupport/Help/Usage_Modules
  2. Localization modules developed by third-party developers. These modules have to follow instructions given at http://forge.openbravo.com/plugins/mwiki/index.php/Openbravoforgesupport/Help/Usage_Localization
  3. Core projects Openbravo ERP and Openbravo POS.
  4. Extension modules which require a private collaboration space (OB@OB, HIS, ...).

How to

This is the detailed process that has to be followed by Openbravo developers:

  1. Create a new PUBLIC project in the Forge selecting the following services http://forge.openbravo.com/register/projectinfo.php
    1. Forums
    2. Downloads
    3. Wiki
    4. News
    5. Bug Tracking
    6. Code
    7. Module
  2. Forums. Use and MONITOR forums in order to facilitate the discussion. Monitoring Forums is especially important for commercial modules and if there is no monitoring then it is better just to switch Forum off (it will redirect users to the Openbravo ERP / POS Forums which are under review of more people).
  3. Downloads. Use Downloads section for uploading files such as *.PDF files, *.DOC files, *.PPT files, ...
  4. Wiki. Use Openbravo Wiki to document specifications and user manuals of the module.
    1. Create a new article in Openbravo Wiki in the type http://wiki.openbravo.com/wiki/Projects/My_Project
    2. Follow the Development Documentation Style Guide article.
    3. Go back to the Forge project and click on Admin link.
      1. Select Wiki in the list and click on Edit.
      2. In Link to an external web service? select Yes.
      3. In External web service link: field type the Openbravo Wiki link.
      4. Click on Save button.
  5. News. Use News section to announce the project creation and status (documentation publication, module availability, ...).
  6. Bug Tracking. Use Openbravo Issue Tracker for tracking defects and feature requests for Openbravo modules.
    1. Openbravo modules are tracked in the corresponding category inside the ERP Extensions > Modules project.
    2. To request for a new category to be created in ERP Extensions > Modules project:
      1. Report a new issue in Mantis@OB project:
        1. Type = Defect
        2. Category = Request: new module
        3. Summary = Your Module Name
        4. Description = Your Module Name
    3. Link Bug Tracking menu of the Forge project to the corresponding to this module section of issues.openbravo.com (here is the example link https://issues.openbravo.com/search.php?project_id=20&category=Advance+Payables+and+Receivables&sticky_issues=on&sortby=last_updated&dir=DESC&hide_status_id=90).
    4. Add your module to the Bug reporting Guidelines projects list, in an alphabetical order.
  7. Code. Use Openbravo Code Repositories to version your module.
    1. Ask Release Management Team to create a space in Mercurial for your module (to be replaced by a web interface).
      1. Send an e-mail to staff.rm@openbravo.com with the following information:
        1. Module package name: org.openbravo....
        2. Module description
        3. Module privacy: Public (https://code.openbravo.com/erp/mods) or Private, for commercial modules (https://code.openbravo.com/erp/pmods)
        4. Contact name: yours or team name
        5. Team e-mail address: team.erpengineering.support@openbravo.com, team.erpengineering.development@openbravo.com, ...
    2. Go back to the Forge project and click on Admin link.
      1. Select Code in the list and click on Edit.
      2. In Link to an external web service? select Yes.
      3. In External web service link: field type the Openbravo Code Repositories link.
      4. Click on Save button.
  8. Module. Use Module section for publishing the fully functional versions of your module.
    1. Before publishing a module please inform PJU, ICI, RMO and DME to agree whether the module has to be commercial or not.
    2. As a general rule:
      1. the code of commercial modules is versioned in a Private repository space (inside https://code.openbravo.com/erp/pmods)
      2. and the documentation (both functional and technical) will be publicly available in the Openbravo Wiki.
  9. Example: Initial Data Load project is an example of a public Forge project for a commercial module http://forge.openbravo.com/projects/xidl
    1. The project is Public (not Private).
    2. Forums are open.
    3. Documentation of the project (both functional and technical doc, user manual) is open.
    4. Bug tracker points to issues.openbravo.com (because it is an Openbravo module).
    5. Code is Private (not Public), this means that is is versioned in the private module repository (pmods) inside code.openbravo.com. https://code.openbravo.com/erp/pmods/org.openbravo.idl/
    6. Module has been published and is Commercial: you see it in the project but, if you try to download it you get an error message saying that you can only download it it via the Module Management Console inside Openbravo ERP. http://forge.openbravo.com/projects/xidl/module

Pending actions

  1. Create missing projects in Forge (Pentaho).
  2. Create/modify the Projects and Categories in Mantis.
  3. Move Forge trackers issues to the proper Projects and Categories in Mantis.
  4. Point Forge trackers to the corresponding Projects and Categories in Mantis.
  5. Create/move Wiki articles to wiki.openbravo.com
  6. Link Forge Wiki tab to the project mainpage
  7. Take SVN code from Forge projects.
  8. Move code to Mercurial repository https://code.openbravo.com/erp/mods
  9. Update the Bug Reporting Guidelines

Completed actions

Open discussion items

  1. Migration of existing issues in Forge trackers. Nowadays there are not too many issues logged in the trackers of Openbravo modules so the migration could be done manually.
  2. Actions items that may not provide value for already existing projects:
    1. Create/move Wiki articles to wiki.openbravo.com
    2. Link Forge Wiki tab to the project mainpage

Closed discussion items

Retrieved from "http://forge.openbravo.com/plugins/mwiki/index.php/Openbravoforgesupport/Help/Usage_Openbravo_Modules"

This page has been accessed 10,448 times. This page was last modified on 10 September 2010, at 15:11. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.