You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by Groza Danut <gr...@gmail.com> on 2025/01/23 20:12:11 UTC

Improve README

Hi all,

I was working a bit more on deploying Ofbiz these days and I found it a bit
hard to find the right commands in the README documentation file.

If you don't have any objections, I would like to structure the file to be
a bit friendlier with beginners, and I'll create a PR for a commiter to
check it.

Groza Danut

Re: Improve README

Posted by Jacques Le Roux <ja...@les7arts.com>.
+1

Jacques

Le 24/01/2025 à 11:04, Groza Danut a écrit :
> Hi Jacques,
>
> Nothing too dramatic, just the following:
>
> 1. Rearrangements
> - in the quick start section add some more explanations and make steps
> explicit
> - create a Gradle commands reference section that summarizes all Gradle
> commands in one place(I think a table with command name and description
> would do)
>
> 2. Additions
> - new section with a simple production deployment configuration and a link
> to the Confluence production settings page for more detailed information
> - a link to the Confluence tips and tricks page
> Groza Danut
>
> On Fri, Jan 24, 2025, 10:50 Jacques Le Roux <ja...@les7arts.com>
> wrote:
>
>> Hi Groza,
>>
>> Before you put efforts in that, what do you propose to do exactly?
>>
>> Could you give us an idea about that with a small summary? TIA
>>
>> Jacques
>>
>> Le 24/01/2025 à 08:18, Pranay Pandey a écrit :
>>> Hi Groza,
>>>
>>> Yes, that will be very helpful.
>>>
>>> Best regards,
>>> Pranay Pandey
>>>
>>>
>>> On Fri, 24 Jan 2025 at 01:42, Groza Danut<gr...@gmail.com>
>> wrote:
>>>> Hi all,
>>>>
>>>> I was working a bit more on deploying Ofbiz these days and I found it a
>> bit
>>>> hard to find the right commands in the README documentation file.
>>>>
>>>> If you don't have any objections, I would like to structure the file to
>> be
>>>> a bit friendlier with beginners, and I'll create a PR for a commiter to
>>>> check it.
>>>>
>>>> Groza Danut
>>>>

Re: Improve README

Posted by Pranay Pandey <pr...@noitechnologies.com>.
+1

Best regards,
Pranay Pandey


On Fri, 24 Jan 2025 at 15:35, Groza Danut <gr...@gmail.com> wrote:

> Hi Jacques,
>
> Nothing too dramatic, just the following:
>
> 1. Rearrangements
> - in the quick start section add some more explanations and make steps
> explicit
> - create a Gradle commands reference section that summarizes all Gradle
> commands in one place(I think a table with command name and description
> would do)
>
> 2. Additions
> - new section with a simple production deployment configuration and a link
> to the Confluence production settings page for more detailed information
> - a link to the Confluence tips and tricks page
> Groza Danut
>
> On Fri, Jan 24, 2025, 10:50 Jacques Le Roux <ja...@les7arts.com>
> wrote:
>
> > Hi Groza,
> >
> > Before you put efforts in that, what do you propose to do exactly?
> >
> > Could you give us an idea about that with a small summary? TIA
> >
> > Jacques
> >
> > Le 24/01/2025 à 08:18, Pranay Pandey a écrit :
> > > Hi Groza,
> > >
> > > Yes, that will be very helpful.
> > >
> > > Best regards,
> > > Pranay Pandey
> > >
> > >
> > > On Fri, 24 Jan 2025 at 01:42, Groza Danut<gr...@gmail.com>
> > wrote:
> > >
> > >> Hi all,
> > >>
> > >> I was working a bit more on deploying Ofbiz these days and I found it
> a
> > bit
> > >> hard to find the right commands in the README documentation file.
> > >>
> > >> If you don't have any objections, I would like to structure the file
> to
> > be
> > >> a bit friendlier with beginners, and I'll create a PR for a commiter
> to
> > >> check it.
> > >>
> > >> Groza Danut
> > >>
>

Re: Improve README

Posted by Groza Danut <gr...@gmail.com>.
Hi Jacques,

Nothing too dramatic, just the following:

1. Rearrangements
- in the quick start section add some more explanations and make steps
explicit
- create a Gradle commands reference section that summarizes all Gradle
commands in one place(I think a table with command name and description
would do)

2. Additions
- new section with a simple production deployment configuration and a link
to the Confluence production settings page for more detailed information
- a link to the Confluence tips and tricks page
Groza Danut

On Fri, Jan 24, 2025, 10:50 Jacques Le Roux <ja...@les7arts.com>
wrote:

> Hi Groza,
>
> Before you put efforts in that, what do you propose to do exactly?
>
> Could you give us an idea about that with a small summary? TIA
>
> Jacques
>
> Le 24/01/2025 à 08:18, Pranay Pandey a écrit :
> > Hi Groza,
> >
> > Yes, that will be very helpful.
> >
> > Best regards,
> > Pranay Pandey
> >
> >
> > On Fri, 24 Jan 2025 at 01:42, Groza Danut<gr...@gmail.com>
> wrote:
> >
> >> Hi all,
> >>
> >> I was working a bit more on deploying Ofbiz these days and I found it a
> bit
> >> hard to find the right commands in the README documentation file.
> >>
> >> If you don't have any objections, I would like to structure the file to
> be
> >> a bit friendlier with beginners, and I'll create a PR for a commiter to
> >> check it.
> >>
> >> Groza Danut
> >>

Re: Improve README

Posted by Jacques Le Roux <ja...@les7arts.com>.
Hi Groza,

Before you put efforts in that, what do you propose to do exactly?

Could you give us an idea about that with a small summary? TIA

Jacques

Le 24/01/2025 à 08:18, Pranay Pandey a écrit :
> Hi Groza,
>
> Yes, that will be very helpful.
>
> Best regards,
> Pranay Pandey
>
>
> On Fri, 24 Jan 2025 at 01:42, Groza Danut<gr...@gmail.com>  wrote:
>
>> Hi all,
>>
>> I was working a bit more on deploying Ofbiz these days and I found it a bit
>> hard to find the right commands in the README documentation file.
>>
>> If you don't have any objections, I would like to structure the file to be
>> a bit friendlier with beginners, and I'll create a PR for a commiter to
>> check it.
>>
>> Groza Danut
>>

Re: Improve README

Posted by Pranay Pandey <pr...@noitechnologies.com>.
Hi Groza,

Yes, that will be very helpful.

Best regards,
Pranay Pandey


On Fri, 24 Jan 2025 at 01:42, Groza Danut <gr...@gmail.com> wrote:

> Hi all,
>
> I was working a bit more on deploying Ofbiz these days and I found it a bit
> hard to find the right commands in the README documentation file.
>
> If you don't have any objections, I would like to structure the file to be
> a bit friendlier with beginners, and I'll create a PR for a commiter to
> check it.
>
> Groza Danut
>