It's not a matter of improving it's a matter of principle. I think you are making an argument in a place not designed for arguments. Arguments happen in the mailing list or in JIRA comments, not documentation, commit logs, or other such references.
I hope we agree at least on this principle and if you do agree then may I suggest you remove the sections that are opinion based. On Jan 11, 2018 11:30 AM, "Jacques Le Roux" <jacques.le.r...@les7arts.com> wrote: > As I said, feel free to improve. You can remove this section if you want > > Jacques > > Le 11/01/2018 à 07:19, Taher Alkhateeb a écrit : > >> Why are you putting your opinion and referencing pros and cons of buildbot >> in a documentation file? Documentation is supposed to be a source for >> explaining what things are and how they work, not what you think of them! >> Typing "IMO" in a documentation is really strange to me. >> >> On Jan 9, 2018 6:20 PM, <jler...@apache.org> wrote: >> >> Author: jleroux >>> Date: Tue Jan 9 15:20:58 2018 >>> New Revision: 1820671 >>> >>> URL: http://svn.apache.org/viewvc?rev=1820671&view=rev >>> Log: >>> Fixes(?) MD syntax for HTML import >>> >>> Modified: >>> ofbiz/tools/documentation/BuildBot/BuildBot.md >>> ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html >>> >>> Modified: ofbiz/tools/documentation/BuildBot/BuildBot.md >>> URL: http://svn.apache.org/viewvc/ofbiz/tools/documentation/ >>> BuildBot/BuildBot.md?rev=1820671&r1=1820670&r2=1820671&view=diff >>> ============================================================ >>> ================== >>> --- ofbiz/tools/documentation/BuildBot/BuildBot.md (original) >>> +++ ofbiz/tools/documentation/BuildBot/BuildBot.md Tue Jan 9 15:20:58 >>> 2018 >>> @@ -23,6 +23,7 @@ BuilbBot documentation >>> OFBiz uses [BuilbBot](https://en.wikipedia.org/wiki/Buildbot) as its >>> Continuous Integration (CI) tool. There are other CI tools [used at the >>> ASF](https://ci.apache.org/). >>> >>> IMO the BuildBot pros and cons are >>> + >>> ### Pros >>> * Compared to a tool like Jenkins (those are the 2 I know) you don't >>> have >>> to use an UI, you write scripts. This is also a cons for some. >>> * The syntax is simple and well documented, some prefer intuitive UI. >>> >>> Modified: ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html >>> URL: http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/ >>> BuildBot/BuildBot.md.html?rev=1820671&r1=1820670&r2=1820671&view=diff >>> ============================================================ >>> ================== >>> --- ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html (original) >>> +++ ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html Tue Jan 9 15:20:58 >>> 2018 >>> @@ -29,8 +29,15 @@ under the License. >>> <h1 id="builbbot-documentation">BuilbBot documentation</h1> >>> <h2 id="what-is-builbbot-and-why-using-it">What is BuilbBot and why >>> using it?</h2> >>> <p>OFBiz uses <a href="https://en.wikipedia.org/wiki/Buildbot >>> ">BuilbBot</a> >>> as its Continuous Integration (CI) tool. There are other CI tools <a >>> href=" >>> https://ci.apache.org/";>used at the ASF</a>.</p> >>> -<p>IMO the BuildBot pros and cons are ### Pros * Compared to a tool like >>> Jenkins (those are the 2 I know) you don't have to use an UI, you write >>> scripts. This is also a cons for some. * The syntax is simple and well >>> documented, some prefer intuitive UI. * The infra team at the ASF >>> provides >>> a kind of compiler which prevents to commits error in the shared script >>> (the builders are all common to the ASF)<br /> >>> -* The infra team, especially Gavin McDonald, is always ready to help in >>> a >>> very efficient way</p> >>> +<p>IMO the BuildBot pros and cons are</p> >>> +<h3 id="pros">Pros</h3> >>> +<ul> >>> +<li>Compared to a tool like Jenkins (those are the 2 I know) you don't >>> have to use an UI, you write scripts. This is also a cons for some.</li> >>> +<li>The syntax is simple and well documented, some prefer intuitive >>> UI.</li> >>> +<li>The infra team at the ASF provides a kind of compiler which prevents >>> to commits error in the shared script (the builders are all common to the >>> ASF)<br /> >>> +</li> >>> +<li>The infra team, especially Gavin McDonald, is always ready to help >>> in >>> a very efficient way</li> >>> +</ul> >>> <h3 id="cons">Cons</h3> >>> <ul> >>> <li>You have no UI so you have to write your own scripts, some prefer >>> UIs >>> to scripts.</li> >>> >>> >>> >>> >
