Re: svn commit: r1818093 - /ofbiz/ofbiz-framework/trunk/README.md

[taher]

This is too specific to include in the general README.md file. I don't
think we need to keep every workaround and every specific detail
otherwise this file would get too large. This is especially true because
you added the comment under a very specific instruction that was
discussed in a thread.

I recommend removing it.


On 12/14/2017 10:38 AM, [hidden email] wrote:

> Author: jleroux
> Date: Thu Dec 14 07:38:45 2017
> New Revision: 1818093
>
> URL: http://svn.apache.org/viewvc?rev=1818093&view=rev
> Log:
> No functional change, warning about dashes
>
> Modified:
>      ofbiz/ofbiz-framework/trunk/README.md
>
> Modified: ofbiz/ofbiz-framework/trunk/README.md
> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/README.md?rev=1818093&r1=1818092&r2=1818093&view=diff
> ==============================================================================
> --- ofbiz/ofbiz-framework/trunk/README.md (original)
> +++ ofbiz/ofbiz-framework/trunk/README.md Thu Dec 14 07:38:45 2017
> @@ -328,6 +328,11 @@ Example:
>  
>   `gradlew "ofbiz --load-data readers=seed,seed-initial,ext,ext-demo"`
>  
> +<span style="color:red">
> +Beware that copying this command in Microsoft Word will automatically transform the double dash in en dashes (Unicode 0x2013: –)
> +Other cases not related to Word were also reported.So when this command does not work check that you are using dash!
> +text</span>
> +
>   #### Load all OFBiz data
>  
>   Loads all data sets; meant for initial loading of generic OFBiz data.
>
>

[Jacques Le Roux]

I wonder, we had already at least 2 persons crossing this issue and it's not obvious to spot it's this one and remember the solution.

Maybe we can move it to another place but keep it there? Finding
https://cwiki.apache.org/confluence/display/OFBENDUSER/How+to+Install+OFBiz+without+the+Demo+Data seems not enough for some people

What do others think?

Jacques


Le 14/12/2017 à 08:42, Taher Alkhateeb a écrit :

> This is too specific to include in the general README.md file. I don't think we need to keep every workaround and every specific detail otherwise
> this file would get too large. This is especially true because you added the comment under a very specific instruction that was discussed in a thread.
>
> I recommend removing it.
>
>
> On 12/14/2017 10:38 AM, [hidden email] wrote:
>> Author: jleroux
>> Date: Thu Dec 14 07:38:45 2017
>> New Revision: 1818093
>>
>> URL: http://svn.apache.org/viewvc?rev=1818093&view=rev
>> Log:
>> No functional change, warning about dashes
>>
>> Modified:
>>      ofbiz/ofbiz-framework/trunk/README.md
>>
>> Modified: ofbiz/ofbiz-framework/trunk/README.md
>> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/README.md?rev=1818093&r1=1818092&r2=1818093&view=diff
>> ==============================================================================
>> --- ofbiz/ofbiz-framework/trunk/README.md (original)
>> +++ ofbiz/ofbiz-framework/trunk/README.md Thu Dec 14 07:38:45 2017
>> @@ -328,6 +328,11 @@ Example:
>>     `gradlew "ofbiz --load-data readers=seed,seed-initial,ext,ext-demo"`
>>   +<span style="color:red">
>> +Beware that copying this command in Microsoft Word will automatically transform the double dash in en dashes (Unicode 0x2013: –)
>> +Other cases not related to Word were also reported.So when this command does not work check that you are using dash!
>> +text</span>
>> +
>>   #### Load all OFBiz data
>>     Loads all data sets; meant for initial loading of generic OFBiz data.
>>
>>
>
>

[Michael Brohl-3]

I suggest to create an FAQ or "known issues" section in our wiki and
have a section in the README.md like "further reading" or "additional
infos" etc. which contain the links.

Regards,

Michael


Am 14.12.17 um 09:12 schrieb Jacques Le Roux:

> I wonder, we had already at least 2 persons crossing this issue and
> it's not obvious to spot it's this one and remember the solution.
>
> Maybe we can move it to another place but keep it there? Finding
> https://cwiki.apache.org/confluence/display/OFBENDUSER/How+to+Install+OFBiz+without+the+Demo+Data 
> seems not enough for some people
>
> What do others think?
>
> Jacques
>
>
> Le 14/12/2017 à 08:42, Taher Alkhateeb a écrit :
>> This is too specific to include in the general README.md file. I
>> don't think we need to keep every workaround and every specific
>> detail otherwise this file would get too large. This is especially
>> true because you added the comment under a very specific instruction
>> that was discussed in a thread.
>>
>> I recommend removing it.
>>
>>
>> On 12/14/2017 10:38 AM, [hidden email] wrote:
>>> Author: jleroux
>>> Date: Thu Dec 14 07:38:45 2017
>>> New Revision: 1818093
>>>
>>> URL: http://svn.apache.org/viewvc?rev=1818093&view=rev
>>> Log:
>>> No functional change, warning about dashes
>>>
>>> Modified:
>>>      ofbiz/ofbiz-framework/trunk/README.md
>>>
>>> Modified: ofbiz/ofbiz-framework/trunk/README.md
>>> URL:
>>> http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/README.md?rev=1818093&r1=1818092&r2=1818093&view=diff
>>> ==============================================================================
>>>
>>> --- ofbiz/ofbiz-framework/trunk/README.md (original)
>>> +++ ofbiz/ofbiz-framework/trunk/README.md Thu Dec 14 07:38:45 2017
>>> @@ -328,6 +328,11 @@ Example:
>>>     `gradlew "ofbiz --load-data
>>> readers=seed,seed-initial,ext,ext-demo"`
>>>   +<span style="color:red">
>>> +Beware that copying this command in Microsoft Word will
>>> automatically transform the double dash in en dashes (Unicode
>>> 0x2013: –)
>>> +Other cases not related to Word were also reported.So when this
>>> command does not work check that you are using dash!
>>> +text</span>
>>> +
>>>   #### Load all OFBiz data
>>>     Loads all data sets; meant for initial loading of generic OFBiz
>>> data.
>>>
>>>
>>
>>
>

[Jacopo Cappellato-5]

On Thu, Dec 14, 2017 at 10:02 AM, Michael Brohl <[hidden email]>
wrote:

> I suggest to create an FAQ or "known issues" section in our wiki and have
> a section in the README.md like "further reading" or "additional infos"
> etc. which contain the links.
>
> Regards,
>
> Michael
>

+1

This is a good idea Michael!

Jacopo

[taher]

Yup +1

One remark, I recommend the "further reading" section should be
somewhere at the bottom of the README.md. We keep adding stuff to the
top of this file which keeps hiding away the most important part of
the README.md to new comers: the "Quick start" section.

On Thu, Dec 14, 2017 at 12:22 PM, Jacopo Cappellato
<[hidden email]> wrote:

> On Thu, Dec 14, 2017 at 10:02 AM, Michael Brohl <[hidden email]>
> wrote:
>
>> I suggest to create an FAQ or "known issues" section in our wiki and have
>> a section in the README.md like "further reading" or "additional infos"
>> etc. which contain the links.
>>
>> Regards,
>>
>> Michael
>>
>
> +1
>
> This is a good idea Michael!
>
> Jacopo

[Jacques Le Roux]

We have already a FAQ, I'll add a "known issues" section there and add a link at bottom of the README.md

But should we not warn new users in the the "Quick start" section about this dash issue which came at least 3 times now

Jacques


Le 14/12/2017 à 10:40, Taher Alkhateeb a écrit :

> Yup +1
>
> One remark, I recommend the "further reading" section should be
> somewhere at the bottom of the README.md. We keep adding stuff to the
> top of this file which keeps hiding away the most important part of
> the README.md to new comers: the "Quick start" section.
>
> On Thu, Dec 14, 2017 at 12:22 PM, Jacopo Cappellato
> <[hidden email]> wrote:
>> On Thu, Dec 14, 2017 at 10:02 AM, Michael Brohl <[hidden email]>
>> wrote:
>>
>>> I suggest to create an FAQ or "known issues" section in our wiki and have
>>> a section in the README.md like "further reading" or "additional infos"
>>> etc. which contain the links.
>>>
>>> Regards,
>>>
>>> Michael
>>>
>> +1
>>
>> This is a good idea Michael!
>>
>> Jacopo

[Jacques Le Roux]

Done at revision: 1818125

BTW, I find funny that users have to get to this section after failing with the "Quick start" section ;)

"C'est la vie" would say some

Jacques


Le 14/12/2017 à 13:09, Jacques Le Roux a écrit :

> We have already a FAQ, I'll add a "known issues" section there and add a link at bottom of the README.md
>
> But should we not warn new users in the the "Quick start" section about this dash issue which came at least 3 times now
>
> Jacques
>
>
> Le 14/12/2017 à 10:40, Taher Alkhateeb a écrit :
>> Yup +1
>>
>> One remark, I recommend the "further reading" section should be
>> somewhere at the bottom of the README.md. We keep adding stuff to the
>> top of this file which keeps hiding away the most important part of
>> the README.md to new comers: the "Quick start" section.
>>
>> On Thu, Dec 14, 2017 at 12:22 PM, Jacopo Cappellato
>> <[hidden email]> wrote:
>>> On Thu, Dec 14, 2017 at 10:02 AM, Michael Brohl <[hidden email]>
>>> wrote:
>>>
>>>> I suggest to create an FAQ or "known issues" section in our wiki and have
>>>> a section in the README.md like "further reading" or "additional infos"
>>>> etc. which contain the links.
>>>>
>>>> Regards,
>>>>
>>>> Michael
>>>>
>>> +1
>>>
>>> This is a good idea Michael!
>>>
>>> Jacopo
>
>

[Jacques Le Roux]

I answered to myself at revision: 1818392

Jacques


Le 14/12/2017 à 14:07, Jacques Le Roux a écrit :

> Done at revision: 1818125
>
> BTW, I find funny that users have to get to this section after failing with the "Quick start" section ;)
>
> "C'est la vie" would say some
>
> Jacques
>
>
> Le 14/12/2017 à 13:09, Jacques Le Roux a écrit :
>> We have already a FAQ, I'll add a "known issues" section there and add a link at bottom of the README.md
>>
>> But should we not warn new users in the the "Quick start" section about this dash issue which came at least 3 times now
>>
>> Jacques
>>
>>
>> Le 14/12/2017 à 10:40, Taher Alkhateeb a écrit :
>>> Yup +1
>>>
>>> One remark, I recommend the "further reading" section should be
>>> somewhere at the bottom of the README.md. We keep adding stuff to the
>>> top of this file which keeps hiding away the most important part of
>>> the README.md to new comers: the "Quick start" section.
>>>
>>> On Thu, Dec 14, 2017 at 12:22 PM, Jacopo Cappellato
>>> <[hidden email]> wrote:
>>>> On Thu, Dec 14, 2017 at 10:02 AM, Michael Brohl <[hidden email]>
>>>> wrote:
>>>>
>>>>> I suggest to create an FAQ or "known issues" section in our wiki and have
>>>>> a section in the README.md like "further reading" or "additional infos"
>>>>> etc. which contain the links.
>>>>>
>>>>> Regards,
>>>>>
>>>>> Michael
>>>>>
>>>> +1
>>>>
>>>> This is a good idea Michael!
>>>>
>>>> Jacopo
>>
>>
>
>