[IMP] readme model updated with oca img banner #642

dora-jurcevic · 2025-02-06T15:42:28Z

Readme model modified in order to display a OCA img banner on the top with a link inviting users to become members or sponsors

rousseldenis · 2025-02-06T15:55:43Z

tools/gen_addon_readme.rst.jinja

 {%- endmacro -%}

+.. image:: https://odoo-community.org/web/image/4603934-dcc7fad0/readme_banner_OCA.png
+   :target: https://odoo-community.org/get-involved#scrollTop=0?ref=u3kel3&utm_source=oca-readme-banner-module&utm_medium=referral&utm_campaign=become-member-2025


This implies the campaign should remain open

If you mean the OCA sponsors recruitment campaign, yes, it stays open

I think we need simpler urls and stable that are not tied to odoo implementation details. Otherwise they will rapidly become broken as we upgrade Odoo etc...

I think we need simpler urls and stable that are not tied to odoo implementation details. Otherwise they will rapidly become broken as we upgrade Odoo etc...

That was the feeling I had but @sbidoul said it clearly :-)

vdewulf · 2025-02-07T07:44:13Z

The URL was created with a separate too where I put the original link and added details like the source and the campaign name (but I can remove 2025 for example) to analyse how many people visited the website after clicking on this banner. Can you explain how to change a URL in odoo so that it stays the same after a migration? And how I can use this separate tool so that it works as well? Le ven. 7 févr. 2025, 08:38, Stéphane Bidoul ***@***.***> a écrit :

…

***@***.**** commented on this pull request. ------------------------------ In tools/gen_addon_readme.rst.jinja <#642 (comment)>: > @@ -7,6 +7,11 @@ {% endif %} {%- endmacro -%} +.. image:: https://odoo-community.org/web/image/4603934-dcc7fad0/readme_banner_OCA.png + :target: https://odoo-community.org/get-involved#scrollTop=0?ref=u3kel3&utm_source=oca-readme-banner-module&utm_medium=referral&utm_campaign=become-member-2025 I think we need simpler urls and stable that are not tied to odoo implementation details. Otherwise they will rapidly become broken as we upgrade Odoo etc... — Reply to this email directly, view it on GitHub <#642 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGU2LZRFFSEZXJEV5UFXQSL2ORPJDAVCNFSM6AAAAABWT3OY4SVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMMBRGAYDENBTGM> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

sbidoul · 2025-02-07T08:13:56Z

Can you explain how to change a URL in odoo so that it stays the same after
a migration?

We can probably do somethings with Website Settings > Configuration > Redirects.

sbidoul · 2025-02-07T08:15:38Z

Another comment I have is about the banner. It looks very big and too "advertising".

If we see such a big banner on each addon page, either on pypi.org or our own app store, it will rapidly becoming tiring, I think.

See for instance how it looks now on https://pypi.org/project/odoo-addon-mis-builder/.

Can we do something less intrusive?

dora-jurcevic · 2025-02-07T08:32:31Z

Another comment I have is about the banner. It looks very big and too "advertising".

If we see such a big banner on each addon page, either on pypi.org or our own app store, it will rapidly becoming tiring, I think.

See for instance how it looks now on https://pypi.org/project/odoo-addon-mis-builder/.

Can we do something less intrusive?

So the starting point of the banner idea is the idea that many users use the OCA modules without even knowing that they can "give back" to the community by sponsoring it or becoming members.
In the same time, the "refferal" url will give us the possibility to measure exactly how many people click on the banner and how many "convert" becoming members or sponsors. The idea is also to change this banner regularly, or even to make it evolve. We took as example other open source projects that live thanks to sponsors.

I understand the fear of annoying publicity but if it becomes annoying and in the same time we measure in 6-10 month that is inefficient, it will be a good reason to replace it or remove it completely.

sbidoul · 2025-02-07T12:15:06Z

Yes I understand the goal, but I'm pretty sure that using PyPI blatantly as advertising medium would be frowned upon.

We can achieve the same result with something a more discreet.

dora-jurcevic · 2025-02-10T09:02:38Z

Yes I understand the goal, but I'm pretty sure that using PyPI blatantly as advertising medium would be frowned upon.

We can achieve the same result with something a more discreet.

ok, I understand.
Is there a way to conditionally hide the banner on PyPI ?
If the answer is no, can we include a "promotional message" in text format, with a link to odoo-community website ? Would this be acceptable ?

dora-jurcevic · 2025-02-25T14:16:07Z

Hello @sbidoul @vdewulf @rousseldenis !
We worked on a smaller version of the banner and a more simple referal link.
Please check if this is more suitable for PyPI.
Thx :)

vdewulf · 2025-03-04T12:09:21Z

This looks good to me, but CI is red. Might it be linked to the same issue here:
#639 (comment)?

@sbidoul and @rousseldenis what do you think of the new version proposed by Dora and me?

JayVora-SerpentCS · 2025-03-11T08:53:05Z

Its red, but good to go for merge!

vdewulf · 2025-03-25T09:54:19Z

@etobella Just lookinf for more eyes for this PR to get merged... could you share your feedback with us?
Thanks!

etobella

The change itself looks good, but tests are failing

vdewulf · 2025-04-02T17:43:05Z

The change itself looks good, but tests are failing

Thanks Enric! Indeed it is red, but @dora-jurcevic doesn't know how to make it green and @JayVora-SerpentCS said it was good to merge even if it is red.

What is the best option to move forward?

sbidoul

A couple of comments about stable URLs that I previously mentioned above.

Can you also update the README.expected* files in https://github.com/OCA/maintainer-tools/tree/master/tests/data to fix the tests?

And rebase to get the latest CI updates and fixes.

sbidoul · 2025-05-10T11:51:48Z

tools/gen_addon_readme.rst.jinja

 {%- endmacro -%}

+=======
+.. image:: https://odoo-community.org/web/image/4610395-7254fada/OCA_banner_readme_1256x150px.png


Could we use a nice stable URL here and set up a redirect on the website? In case our website changes we would not want to break existing READMEs.

Hello @sbidoul !
This URL was created when we uploaded the image png on the current OCA Website.
In order to have a stable URL for this image I suppose that we would need a module on the current Odoo ERP that creates a route with for example https://odoo-community.org/oca-readme-banner.png ?
Or is there a more simple way of adding a media on a specific URL in Odoo V14?
Thx !

sbidoul · 2025-05-10T11:51:56Z

tools/gen_addon_readme.rst.jinja


+=======
+.. image:: https://odoo-community.org/web/image/4610395-7254fada/OCA_banner_readme_1256x150px.png
+   :target: https://odoo-community.org/get-involved?ref=k8vx13&utm_source=referral-readme&utm_medium=referral


What is "ref=k8vx13" ? Also here should we not use a stable URL in case the details of our website change in the future?

@sbidoul , here the base URL will be stable https://odoo-community.org/get-involved and we should update each year the referal part of the URL (?ref=k8vx13&utm_source=referral-readme&utm_medium=referral) in the readme repo. If this is not possible (updating the maintainer-tools each year), we should see with @vdewulf to drop the referal part of the url and keep only the base part of the url. This referal part is used for tracking info about the visits on the /get-involved page, to be sure that the visit comes from the readme banner.
@sbidoul, do you think we should avoid updating URL each year ?

sbidoul · 2025-06-03T10:05:18Z

I'm finishing this in #656

[IMP] readme model updated with oca img banner

7df014f

rousseldenis reviewed Feb 6, 2025

View reviewed changes

[FIX] banner size fixed and link modified

887d039

rousseldenis approved these changes Mar 25, 2025

View reviewed changes

etobella reviewed Mar 25, 2025

View reviewed changes

dora-jurcevic mentioned this pull request Apr 21, 2025

Oca top banner test #650

Closed

sbidoul reviewed May 10, 2025

View reviewed changes

sbidoul requested a review from rousseldenis May 10, 2025 11:58

sbidoul closed this Jun 3, 2025

sbidoul mentioned this pull request Jun 3, 2025

gen-addon-readme: add OCA banner image #656

Merged

Uh oh!

[IMP] readme model updated with oca img banner #642

[IMP] readme model updated with oca img banner #642

Uh oh!

Conversation

dora-jurcevic commented Feb 6, 2025 • edited by sbidoul Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vdewulf commented Feb 7, 2025 via email

Uh oh!

sbidoul commented Feb 7, 2025

Uh oh!

sbidoul commented Feb 7, 2025

Uh oh!

dora-jurcevic commented Feb 7, 2025

Uh oh!

sbidoul commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dora-jurcevic commented Feb 10, 2025

Uh oh!

dora-jurcevic commented Feb 25, 2025

Uh oh!

vdewulf commented Mar 4, 2025

Uh oh!

JayVora-SerpentCS commented Mar 11, 2025

Uh oh!

vdewulf commented Mar 25, 2025

Uh oh!

etobella left a comment

Choose a reason for hiding this comment

Uh oh!

vdewulf commented Apr 2, 2025

Uh oh!

sbidoul left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sbidoul commented Jun 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dora-jurcevic commented Feb 6, 2025 •

edited by sbidoul

Loading

sbidoul commented Feb 7, 2025 •

edited

Loading

sbidoul left a comment •

edited

Loading