Community mailing list archives

community@mail.odoo.com

Re: implementing - gitchangelog to odoo and its modules

by
Vauxoo S.A. de C.V., Nhomar Hernandez
- 05/21/2016 21:55:45

On Sat, May 21, 2016 at 7:37 PM, Andreas Becker <andi@lisandi.com> wrote:

Cody Kitterman wrote:

Robert:
     What do you think about Odoo implementing something like gitchangelog: "use your commit log to make beautiful and configurable changelog file"? 
It's compatible with Python 2/3, works on Linux/BSD/MacOSX, and it's default output is ReSTructured text (which is what the doc's are using now).
It could be made to fit nicely with Odoo's Commit message conventions, assuming they were expanded (SEE "Action", "Audience", "Tags"), and would address some of your concerns:
"the actual documentation was a huge source of frustration. Just this week one of my office colleagues who tried to learn how to create a web site creator snippet gave up in frustration. The documentation is just wrong ..
And I learned myself that the JavaScript API documentation is mostly V8 based and of little value for V9. Unless, of course you know what has changed between v8 and v9. For which I found no documentation at all.."
Developers could review these and update their modules and Odoo's documentation.
R/S

Nhomar Hernandez wrote:

Again.
Read the code please!, do not make statements just because people does not look in the right place.
Folder doc into the mail module:
https://github.com/odoo/odoo/tree/9.0/addons/mail/doc
Here:
https://github.com/odoo/odoo/blob/9.0/addons/mail/doc/tracked_field.rst
You can improve what you actually know and make a PR "It is very welcome".
Regards.

Did you actually read what I was answering with this comment?

even if the comment is in the same thread, my answer do not have any relation with the initial comment where you are relating that.

BTW...

IMHO I prefer a proper documented API than a changelog... If you follow the commit log in odoo itself you can check that you will find:

1.- Long commits.
2.- In the PR you have in more or less the 70% of them the link to the pad.
3.- If you RTFC and learn a little of python algorithms are easy to understand.
4.- Functional documentation here: https://github.com/odoo/documentation-user look for the thread in the list, (Help is wanted and necesary there).
5.- Technical doc is here: https://github.com/odoo/odoo/tree/9.0/doc
6.- You can compile with nginx all of it.


IMHO changelog is nice I was working on it and we developed some things which we have in development (based on basic concepts on gitchangelog which is very nice) but if you read the reationale of that package here:

http://stackoverflow.com/questions/3523534/good-ways-to-manage-a-changelog-using-git << IMPORTANT read the thread where the author explain the reationale.

I hope it helps everybody...

BTW 2 important points:

- You can download your odoo's copy and run gitchangelog by yourself not rocket science.
- Please contextualize yourself properly to avoid bad judgement about some threads.

Regards.




--
Nhomar Hernandez
CEO Vauxoo.
Twitter: @nhomar
Odoo Gold Partner
Skype: nhomar00 (Envia mail previo no lo superviso siempre).
Móvil Venezuela:
+58 4144110269
Móvil México:
+52 1 4773933942