API Reference on OFBiz site

[Pawan Verma]

Hello Devs,

Since Oliver has refactored documentation with new directories structure
with the trunk, next and stable API Reference link becomes stale.

Question: What should be the API Reference link on the site?

Possible Solutions:
#1: We can use the link for stable APIs for Site as suggested by Jacques on
Jira OFBIZ-11888.

#2: We can show the link for both trunk and stable release like Build and
Run section.
Example:
*     OFBiz API Reference*

   - *Trunk API Reference*
   - *Release 17.12 API Reference*

Please share your thoughts on this. TIA!

--
Thanks & Regards
Pawan Verma
Technical Consultant
*HotWax Systems*
*Enterprise open source experts*
http://www.hotwaxsystems.com

[Jacques Le Roux]

Thanks Pawan,

The 2nd options looks like a good idea to me.

Jacques

Le 14/07/2020 à 15:38, Pawan Verma a écrit :

> Hello Devs,
>
> Since Oliver has refactored documentation with new directories structure
> with the trunk, next and stable API Reference link becomes stale.
>
> Question: What should be the API Reference link on the site?
>
> Possible Solutions:
> #1: We can use the link for stable APIs for Site as suggested by Jacques on
> Jira OFBIZ-11888.
>
> #2: We can show the link for both trunk and stable release like Build and
> Run section.
> Example:
> *     OFBiz API Reference*
>
>     - *Trunk API Reference*
>     - *Release 17.12 API Reference*
>
> Please share your thoughts on this. TIA!
>

[Pritam Kute]

I am also inclined to 2nd option.

Thanks, Pawan for pointing this.

Kind Regards,
--
Pritam Kute


On Wed, Jul 15, 2020 at 1:24 AM Jacques Le Roux <
[hidden email]> wrote:

> Thanks Pawan,
>
> The 2nd options looks like a good idea to me.
>
> Jacques
>
> Le 14/07/2020 à 15:38, Pawan Verma a écrit :
> > Hello Devs,
> >
> > Since Oliver has refactored documentation with new directories structure
> > with the trunk, next and stable API Reference link becomes stale.
> >
> > Question: What should be the API Reference link on the site?
> >
> > Possible Solutions:
> > #1: We can use the link for stable APIs for Site as suggested by Jacques
> on
> > Jira OFBIZ-11888.
> >
> > #2: We can show the link for both trunk and stable release like Build and
> > Run section.
> > Example:
> > *     OFBiz API Reference*
> >
> >     - *Trunk API Reference*
> >     - *Release 17.12 API Reference*
> >
> > Please share your thoughts on this. TIA!
> >
>

[Devanshu Vyas-2]

+1 to the 2nd option.

Thanks & Regards,
Devanshu Vyas.


On Wed, Jul 15, 2020 at 10:56 AM Pritam Kute <[hidden email]>
wrote:

> I am also inclined to 2nd option.
>
> Thanks, Pawan for pointing this.
>
> Kind Regards,
> --
> Pritam Kute
>
>
> On Wed, Jul 15, 2020 at 1:24 AM Jacques Le Roux <
> [hidden email]> wrote:
>
> > Thanks Pawan,
> >
> > The 2nd options looks like a good idea to me.
> >
> > Jacques
> >
> > Le 14/07/2020 à 15:38, Pawan Verma a écrit :
> > > Hello Devs,
> > >
> > > Since Oliver has refactored documentation with new directories
> structure
> > > with the trunk, next and stable API Reference link becomes stale.
> > >
> > > Question: What should be the API Reference link on the site?
> > >
> > > Possible Solutions:
> > > #1: We can use the link for stable APIs for Site as suggested by
> Jacques
> > on
> > > Jira OFBIZ-11888.
> > >
> > > #2: We can show the link for both trunk and stable release like Build
> and
> > > Run section.
> > > Example:
> > > *     OFBiz API Reference*
> > >
> > >     - *Trunk API Reference*
> > >     - *Release 17.12 API Reference*
> > >
> > > Please share your thoughts on this. TIA!
> > >
> >
>

[holivier]

+1 to the 2nd option

Le 15/07/2020 à 09:58, Devanshu Vyas a écrit :

> +1 to the 2nd option.
>
> Thanks & Regards,
> Devanshu Vyas.
>
>
> On Wed, Jul 15, 2020 at 10:56 AM Pritam Kute <[hidden email]>
> wrote:
>
>> I am also inclined to 2nd option.
>>
>> Thanks, Pawan for pointing this.
>>
>> Kind Regards,
>> --
>> Pritam Kute
>>
>>
>> On Wed, Jul 15, 2020 at 1:24 AM Jacques Le Roux <
>> [hidden email]> wrote:
>>
>>> Thanks Pawan,
>>>
>>> The 2nd options looks like a good idea to me.
>>>
>>> Jacques
>>>
>>> Le 14/07/2020 à 15:38, Pawan Verma a écrit :
>>>> Hello Devs,
>>>>
>>>> Since Oliver has refactored documentation with new directories
>> structure
>>>> with the trunk, next and stable API Reference link becomes stale.
>>>>
>>>> Question: What should be the API Reference link on the site?
>>>>
>>>> Possible Solutions:
>>>> #1: We can use the link for stable APIs for Site as suggested by
>> Jacques
>>> on
>>>> Jira OFBIZ-11888.
>>>>
>>>> #2: We can show the link for both trunk and stable release like Build
>> and
>>>> Run section.
>>>> Example:
>>>> *     OFBiz API Reference*
>>>>
>>>>     - *Trunk API Reference*
>>>>     - *Release 17.12 API Reference*
>>>>
>>>> Please share your thoughts on this. TIA!
>>>>
>>>
>>
>

[Jacques Le Roux]

After thought: why not expose the next API too?

Jacques

Le 15/07/2020 à 10:19, Olivier Heintz a écrit :

> +1 to the 2nd option
>
> Le 15/07/2020 à 09:58, Devanshu Vyas a écrit :
>> +1 to the 2nd option.
>>
>> Thanks & Regards,
>> Devanshu Vyas.
>>
>>
>> On Wed, Jul 15, 2020 at 10:56 AM Pritam Kute <[hidden email]>
>> wrote:
>>
>>> I am also inclined to 2nd option.
>>>
>>> Thanks, Pawan for pointing this.
>>>
>>> Kind Regards,
>>> --
>>> Pritam Kute
>>>
>>>
>>> On Wed, Jul 15, 2020 at 1:24 AM Jacques Le Roux <
>>> [hidden email]> wrote:
>>>
>>>> Thanks Pawan,
>>>>
>>>> The 2nd options looks like a good idea to me.
>>>>
>>>> Jacques
>>>>
>>>> Le 14/07/2020 à 15:38, Pawan Verma a écrit :
>>>>> Hello Devs,
>>>>>
>>>>> Since Oliver has refactored documentation with new directories
>>> structure
>>>>> with the trunk, next and stable API Reference link becomes stale.
>>>>>
>>>>> Question: What should be the API Reference link on the site?
>>>>>
>>>>> Possible Solutions:
>>>>> #1: We can use the link for stable APIs for Site as suggested by
>>> Jacques
>>>> on
>>>>> Jira OFBIZ-11888.
>>>>>
>>>>> #2: We can show the link for both trunk and stable release like Build
>>> and
>>>>> Run section.
>>>>> Example:
>>>>> *     OFBiz API Reference*
>>>>>
>>>>>      - *Trunk API Reference*
>>>>>      - *Release 17.12 API Reference*
>>>>>
>>>>> Please share your thoughts on this. TIA!
>>>>>

[Pawan Verma]

Hi Jacques,

Yes, seems like a good idea to expose the next API too. But I am not fully
aware of the next API and curious about the label means Next API Reference,
wouldn't it be confusing for the user?
--
Thanks & Regards
Pawan Verma
Technical Consultant
*HotWax Systems*
*Enterprise open source experts*
http://www.hotwaxsystems.com


On Wed, Jul 15, 2020 at 2:38 PM Jacques Le Roux <
[hidden email]> wrote:

> After thought: why not expose the next API too?
>
> Jacques
>
> Le 15/07/2020 à 10:19, Olivier Heintz a écrit :
> > +1 to the 2nd option
> >
> > Le 15/07/2020 à 09:58, Devanshu Vyas a écrit :
> >> +1 to the 2nd option.
> >>
> >> Thanks & Regards,
> >> Devanshu Vyas.
> >>
> >>
> >> On Wed, Jul 15, 2020 at 10:56 AM Pritam Kute <
> [hidden email]>
> >> wrote:
> >>
> >>> I am also inclined to 2nd option.
> >>>
> >>> Thanks, Pawan for pointing this.
> >>>
> >>> Kind Regards,
> >>> --
> >>> Pritam Kute
> >>>
> >>>
> >>> On Wed, Jul 15, 2020 at 1:24 AM Jacques Le Roux <
> >>> [hidden email]> wrote:
> >>>
> >>>> Thanks Pawan,
> >>>>
> >>>> The 2nd options looks like a good idea to me.
> >>>>
> >>>> Jacques
> >>>>
> >>>> Le 14/07/2020 à 15:38, Pawan Verma a écrit :
> >>>>> Hello Devs,
> >>>>>
> >>>>> Since Oliver has refactored documentation with new directories
> >>> structure
> >>>>> with the trunk, next and stable API Reference link becomes stale.
> >>>>>
> >>>>> Question: What should be the API Reference link on the site?
> >>>>>
> >>>>> Possible Solutions:
> >>>>> #1: We can use the link for stable APIs for Site as suggested by
> >>> Jacques
> >>>> on
> >>>>> Jira OFBIZ-11888.
> >>>>>
> >>>>> #2: We can show the link for both trunk and stable release like Build
> >>> and
> >>>>> Run section.
> >>>>> Example:
> >>>>> *     OFBiz API Reference*
> >>>>>
> >>>>>      - *Trunk API Reference*
> >>>>>      - *Release 17.12 API Reference*
> >>>>>
> >>>>> Please share your thoughts on this. TIA!
> >>>>>
>

[Jacques Le Roux]

Hi Pawan,

Indeed, next is for now more an internal concept.

But, like it's now clear for stable - thanks to the demo, we could explain this concept to users. It's simple: the next branch to be released. This
would prevent to have to modify (and often forget) the real reference, ie R18 for now.

Jacques

Le 16/07/2020 à 09:49, Pawan Verma a écrit :
> Hi Jacques,
>
> Yes, seems like a good idea to expose the next API too. But I am not fully
> aware of the next API and curious about the label means Next API Reference,
> wouldn't it be confusing for the user?

[Pawan Verma]

Thanks, Jacques, All for the response.

Yes, Makes sense. So, It will look something like this, if this looks good,
I'll make the required changes.

The layout of API Reference on the Site:
*OFBiz API Reference*

   - *Trunk API Reference*
   - *Release 17.12 API Reference*
   - *Next Release API Reference*

--
Thanks & Regards
Pawan Verma
Technical Consultant
*HotWax Systems*
*Enterprise open source experts*
http://www.hotwaxsystems.com


On Thu, Jul 16, 2020 at 1:46 PM Jacques Le Roux <
[hidden email]> wrote:

> Hi Pawan,
>
> Indeed, next is for now more an internal concept.
>
> But, like it's now clear for stable - thanks to the demo, we could explain
> this concept to users. It's simple: the next branch to be released. This
> would prevent to have to modify (and often forget) the real reference, ie
> R18 for now.
>
> Jacques
>
> Le 16/07/2020 à 09:49, Pawan Verma a écrit :
> > Hi Jacques,
> >
> > Yes, seems like a good idea to expose the next API too. But I am not
> fully
> > aware of the next API and curious about the label means Next API
> Reference,
> > wouldn't it be confusing for the user?
>
>

[Jacques Le Roux]

+1

Jacques

Le 16/07/2020 à 11:43, Pawan Verma a écrit :

> Thanks, Jacques, All for the response.
>
> Yes, Makes sense. So, It will look something like this, if this looks good,
> I'll make the required changes.
>
> The layout of API Reference on the Site:
> *OFBiz API Reference*
>
>     - *Trunk API Reference*
>     - *Release 17.12 API Reference*
>     - *Next Release API Reference*
>

[Pawan Verma]

Changes are live now, please have a look at
https://ofbiz.apache.org/developers.html#DevDocs

If we are good here the ticket can be closed now.
--
Thanks & Regards
Pawan Verma
Technical Consultant
*HotWax Systems*
*Enterprise open source experts*
http://www.hotwaxsystems.com


On Thu, Jul 16, 2020 at 3:26 PM Jacques Le Roux <
[hidden email]> wrote:

> +1
>
> Jacques
>
> Le 16/07/2020 à 11:43, Pawan Verma a écrit :
> > Thanks, Jacques, All for the response.
> >
> > Yes, Makes sense. So, It will look something like this, if this looks
> good,
> > I'll make the required changes.
> >
> > The layout of API Reference on the Site:
> > *OFBiz API Reference*
> >
> >     - *Trunk API Reference*
> >     - *Release 17.12 API Reference*
> >     - *Next Release API Reference*
> >
>

[Devanshu Vyas-2]

Looks good to me.👍

Thanks & Regards,
Devanshu Vyas.


On Thu, Jul 16, 2020 at 4:42 PM Pawan Verma <[hidden email]>
wrote:

> Changes are live now, please have a look at
> https://ofbiz.apache.org/developers.html#DevDocs
>
> If we are good here the ticket can be closed now.
> --
> Thanks & Regards
> Pawan Verma
> Technical Consultant
> *HotWax Systems*
> *Enterprise open source experts*
> http://www.hotwaxsystems.com
>
>
> On Thu, Jul 16, 2020 at 3:26 PM Jacques Le Roux <
> [hidden email]> wrote:
>
> > +1
> >
> > Jacques
> >
> > Le 16/07/2020 à 11:43, Pawan Verma a écrit :
> > > Thanks, Jacques, All for the response.
> > >
> > > Yes, Makes sense. So, It will look something like this, if this looks
> > good,
> > > I'll make the required changes.
> > >
> > > The layout of API Reference on the Site:
> > > *OFBiz API Reference*
> > >
> > >     - *Trunk API Reference*
> > >     - *Release 17.12 API Reference*
> > >     - *Next Release API Reference*
> > >
> >
>

[Pritam Kute]

Thanks, Pawan. Looks good to me.

Kind Regards,
--
Pritam Kute


On Thu, Jul 16, 2020 at 5:24 PM Devanshu Vyas <[hidden email]>
wrote:

> Looks good to me.👍
>
> Thanks & Regards,
> Devanshu Vyas.
>
>
> On Thu, Jul 16, 2020 at 4:42 PM Pawan Verma <[hidden email]
> >
> wrote:
>
> > Changes are live now, please have a look at
> > https://ofbiz.apache.org/developers.html#DevDocs
> >
> > If we are good here the ticket can be closed now.
> > --
> > Thanks & Regards
> > Pawan Verma
> > Technical Consultant
> > *HotWax Systems*
> > *Enterprise open source experts*
> > http://www.hotwaxsystems.com
> >
> >
> > On Thu, Jul 16, 2020 at 3:26 PM Jacques Le Roux <
> > [hidden email]> wrote:
> >
> > > +1
> > >
> > > Jacques
> > >
> > > Le 16/07/2020 à 11:43, Pawan Verma a écrit :
> > > > Thanks, Jacques, All for the response.
> > > >
> > > > Yes, Makes sense. So, It will look something like this, if this looks
> > > good,
> > > > I'll make the required changes.
> > > >
> > > > The layout of API Reference on the Site:
> > > > *OFBiz API Reference*
> > > >
> > > >     - *Trunk API Reference*
> > > >     - *Release 17.12 API Reference*
> > > >     - *Next Release API Reference*
> > > >
> > >
> >
>

[Jacques Le Roux]

Hi Pawan,

That looks good but we have a problem with the menu Documentation/API Reference

Jacques

Le 16/07/2020 à 14:12, Pritam Kute a écrit :

> Thanks, Pawan. Looks good to me.
>
> Kind Regards,
> --
> Pritam Kute
>
>
> On Thu, Jul 16, 2020 at 5:24 PM Devanshu Vyas <[hidden email]>
> wrote:
>
>> Looks good to me.👍
>>
>> Thanks & Regards,
>> Devanshu Vyas.
>>
>>
>> On Thu, Jul 16, 2020 at 4:42 PM Pawan Verma <[hidden email]
>> wrote:
>>
>>> Changes are live now, please have a look at
>>> https://ofbiz.apache.org/developers.html#DevDocs
>>>
>>> If we are good here the ticket can be closed now.
>>> --
>>> Thanks & Regards
>>> Pawan Verma
>>> Technical Consultant
>>> *HotWax Systems*
>>> *Enterprise open source experts*
>>> http://www.hotwaxsystems.com
>>>
>>>
>>> On Thu, Jul 16, 2020 at 3:26 PM Jacques Le Roux <
>>> [hidden email]> wrote:
>>>
>>>> +1
>>>>
>>>> Jacques
>>>>
>>>> Le 16/07/2020 à 11:43, Pawan Verma a écrit :
>>>>> Thanks, Jacques, All for the response.
>>>>>
>>>>> Yes, Makes sense. So, It will look something like this, if this looks
>>>> good,
>>>>> I'll make the required changes.
>>>>>
>>>>> The layout of API Reference on the Site:
>>>>> *OFBiz API Reference*
>>>>>
>>>>>      - *Trunk API Reference*
>>>>>      - *Release 17.12 API Reference*
>>>>>      - *Next Release API Reference*
>>>>>