Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the README and added functional workflow #18

Merged
merged 25 commits into from
Sep 13, 2016
Merged

Conversation

elicoidal
Copy link
Contributor

@elicoidal elicoidal commented Sep 11, 2016

@dreispt This will become the base introduction for all modules

Usage
=====
Simple BR
---------
1. Define the header information
* Master Project (Partner is the one related to the master project)
....
.. figure:: static/img/bus_req_tags2.png
:width: 600 px
:alt: THIS ITEM IS ROOT
2. Input the customer story, scenario and gap (simple html editor with image and text)

Should be

Usage
=====
Simple BR
---------
1. Define the header information
* Master Project (Partner is the one related to the master project)
.. figure:: static/img/bus_req_tags2.png
:width: 600 px
:alt: THIS ITEM ISN'T ROOT (because have prefix spaces)
1. Input the customer story, scenario and gap (simple html editor with image and text)
.. figure:: ../business_requirement/static/img/bus_req_tree.png
:width: 600 px
:alt: Business Requirement List view
Multiple modules integrate the BR with other business areas, such as Sales,
Procurement, Project or Analytic Accounting. For example:
* Sales Quotation can have an estimation supported by a BR analysis
* Project Tasks can be related to the BRs they implement or support
* Procurement and purchase can be generated out of the BR
.. figure:: business_requirement/static/img/bus_req_module_diag.png
:width: 600 px
.. figure:: static/img/bus_req_module_diag.png
:width: 600 px
:alt: Business Requirement modules diagram

and get this:
screenshot from 2016-09-13 21-15-08
both options are valid for Odoo AND my rst editor does like the first option

  

Modified the openerp.py too remove unused images
@moylop I have a problem with travis that my rst editor doesnot spot (enumerated lists).
Can you help me?
@moylop, I have an error (title too short) which I dont know where it comes from...
Thanks for your help!
@dreispt
Copy link
Sponsor Member

dreispt commented Sep 11, 2016

Pylint reports some RST issues.

@elicoidal
Copy link
Contributor Author

@dreispt Yes, I have seen that but my rst editor doesnot complain and output is OK.
I just dont know how to interpret the error: I know it is about the enumerated list in the procedure but cannot find the reason ( @moylop260 ?)

@elicoidal
Copy link
Contributor Author

Hummm: I have to investigate why images are not displayed in the README in settings/local modules

@moylop260
Copy link

moylop260 commented Sep 12, 2016

The enumerate list from section Usage - Simple BR section have root figure elements between items.

Currently:

Usage
=====
Simple BR
---------

1. Define the header information

    * Master Project (Partner is the one related to the master project)
      ...

.. figure:: static/img/bus_req_tags2.png
   :width: 600 px
   :alt: THIS ITEM IS ROOT

2. Input the customer story, scenario and gap (simple html editor with image and text)

Should be

Usage
=====
Simple BR
---------

1. Define the header information

    * Master Project (Partner is the one related to the master project)
      ...

    .. figure:: static/img/bus_req_tags2.png
       :width: 600 px
       :alt: THIS ITEM ISN'T ROOT (because have prefix spaces)

1. Input the customer story, scenario and gap (simple html editor with image and text)

@elicoidal
Copy link
Contributor Author

@moylop260 thanks for the feedback.
Interesting: let me investigate and test a little bit more (diving into the subtleties of rst)

@elicoidal
Copy link
Contributor Author

@victormartinelicocorp I have finally fixed the rst issues (thanks @moylop260 ).
Can you try to tidy up the rest of the warnings in Travis?

@elicoidal
Copy link
Contributor Author

Images in README are not displayed in Odoo / settings/ local modules.
Path seems OK: is there any limitation/different treatment in v8?
I just don't know where to look anymore ( @moylop260 @pedrobaeza any idea)


* Master Project (Partner is the one related to the master project)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indent correctly this at the level of D

@pedrobaeza
Copy link
Member

I remember @eLBati was able to load images both in GitHub, Apps and in Odoo. Lorenzo, can you tell us how you did it?

@elicoidal
Copy link
Contributor Author

elicoidal commented Sep 12, 2016

Indent correctly this at the level of D

@pedrobaeza done but seems not enough

@elicoidal
Copy link
Contributor Author

@pedrobaeza I have come across an annoying situation here.

I have tested locally and come across a solution that somehow contradicts some directive I was given earlier and I am confused now.

I had to use:

.. figure:: business_requirement/static/img/bus_req_tree.png
:width: 600 px
:alt: Business Requirement List view

(including the name of the module)

This is the only way I found to have it display in settings/Modules/local modules. but obviously that doesnot display in my rst editor and GH...
Not sure whether this directive is only applicable to v9 and not workable in v8.

ruter-lyu pushed a commit to ruter-lyu/business-requirement that referenced this pull request Mar 15, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
ruter-lyu pushed a commit to ruter-lyu/business-requirement that referenced this pull request Mar 15, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 4, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 6, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
pedrobaeza pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 21, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 21, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 21, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 26, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jun 26, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Jul 25, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Aug 9, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victormmtorres pushed a commit to Tecnativa/business-requirement that referenced this pull request Aug 19, 2019
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
Tardo pushed a commit to Tecnativa/business-requirement that referenced this pull request Jan 24, 2020
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
Tardo pushed a commit to Tecnativa/business-requirement that referenced this pull request Jan 27, 2020
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
Tardo pushed a commit to Tecnativa/business-requirement that referenced this pull request Mar 3, 2020
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
Tardo pushed a commit to Tecnativa/business-requirement that referenced this pull request Mar 5, 2020
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
Tardo pushed a commit to Tecnativa/business-requirement that referenced this pull request Mar 30, 2020
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victoralmau pushed a commit to Tecnativa/business-requirement that referenced this pull request Oct 14, 2021
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
victoralmau pushed a commit to Tecnativa/business-requirement that referenced this pull request Oct 14, 2021
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
victoralmau pushed a commit to Tecnativa/business-requirement that referenced this pull request Nov 11, 2021
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victoralmau pushed a commit to Tecnativa/business-requirement that referenced this pull request Nov 15, 2021
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
victoralmau pushed a commit to Tecnativa/business-requirement that referenced this pull request Nov 15, 2021
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
MosabWadea pushed a commit to MosabWadea/business-requirement that referenced this pull request Mar 5, 2022
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
MosabWadea pushed a commit to MosabWadea/business-requirement that referenced this pull request Mar 5, 2022
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
bizzappdev pushed a commit to BizzAppDev-Systems/business-requirement that referenced this pull request Mar 4, 2023
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
AntoniRomera pushed a commit to AntoniRomera/business-requirement that referenced this pull request Jul 4, 2023
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
dreispt pushed a commit to dreispt/business-requirement that referenced this pull request Apr 27, 2024
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
dreispt pushed a commit to dreispt/business-requirement that referenced this pull request Apr 27, 2024
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg
NachoAlesLopez pushed a commit to NachoAlesLopez/business-requirement that referenced this pull request Apr 28, 2024
[IMP] business_requirement

* Improved and unified the README for the br_deliverable module
* Modified the openerp.py too remove unused images
* Finetuning
* Remove oca.cfg

Update image link as they where not visible in app

link to this issue: OCA/maintainer-tools#221
@ pedro can we FT this one?

Added double image handling

testing OCA/maintainer-tools#221
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants