OFBiz Documentation Team Volunteers Needed

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
30 messages Options
12
Reply | Threaded
Open this post in threaded view
|

OFBiz Documentation Team Volunteers Needed

Sharan Foga
Hi Everyone

(Trying again as my first post didn't reach this list)

If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.

https://s.apache.org/VfxE

It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.

Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.

Being involved with documentation is a good way to learn OFBiz :-)

So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.

Thanks
Sharan
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

deepak nigam-2
Hi Sharan,

Please consider me in.

Thanks & Regard
--
Deepak Nigam

On Feb 7, 2018 7:02 PM, "Sharan Foga" <[hidden email]> wrote:

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a
> section about the discussions that have been happening on our development
> list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in
> various formats. This means that we can start to consolidate our OFBiz
> documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is
> moved into our current trunk we will need to start some documentation work.
> We will be looking for volunteers to become part of a documentation team
> that will work on reviewing the documents we already have in the wiki and
> other sources, then help to re-structure them to fit into the new
> documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team
> then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Arthur Marquez
In reply to this post by Sharan Foga
Sharan,
I'm uncertain how I wold be able to contribute. However, I'm deeply
curious, so place me in the queue!

Arthur


*Arthur Marquez*

*1-701-872-4471 : Office*
*1-818-919-5452 : Mobile*

*Farmers Union Oil Company of Beach ND*
*Farmers Union Propane, C3H8*
*90 NE 1st St.*
*Beach ND 58621*


*http://www.cenexofbeach.com/ <http://www.cenexofbeach.com/>*



On Wed, Feb 7, 2018 at 6:32 AM, Sharan Foga <[hidden email]> wrote:

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a
> section about the discussions that have been happening on our development
> list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in
> various formats. This means that we can start to consolidate our OFBiz
> documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is
> moved into our current trunk we will need to start some documentation work.
> We will be looking for volunteers to become part of a documentation team
> that will work on reviewing the documents we already have in the wiki and
> other sources, then help to re-structure them to fit into the new
> documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team
> then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Swapnil Mane
In reply to this post by Sharan Foga
Thanks for the updates Sharan, please count me in.


- Best Regards,
Swapnil M Mane,
www.hotwaxsystems.com

On Wed, Feb 7, 2018 at 7:02 PM, Sharan Foga <[hidden email]> wrote:

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a
> section about the discussions that have been happening on our development
> list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in
> various formats. This means that we can start to consolidate our OFBiz
> documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is
> moved into our current trunk we will need to start some documentation work.
> We will be looking for volunteers to become part of a documentation team
> that will work on reviewing the documents we already have in the wiki and
> other sources, then help to re-structure them to fit into the new
> documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team
> then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Michael Brohl-3
In reply to this post by Sharan Foga
Hi Sharan,

please add me to the list :-)

Regards,

Michael

Am 07.02.18 um 14:32 schrieb Sharan Foga:

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Pranay Pandey-4
Hi Sharan,

Please count me in.

Best regards,

Pranay Pandey
www.hotwax.co

On Thu, Feb 8, 2018 at 1:59 PM, Michael Brohl <[hidden email]>
wrote:

> Hi Sharan,
>
> please add me to the list :-)
>
> Regards,
>
> Michael
>
> Am 07.02.18 um 14:32 schrieb Sharan Foga:
>
> Hi Everyone
>>
>> (Trying again as my first post didn't reach this list)
>>
>> If you have read the latest project blog post then you will have seen a
>> section about the discussions that have been happening on our development
>> list about the new proposed OFBiz documentation framework.
>>
>> https://s.apache.org/VfxE
>>
>> It is based on asciidoc and will be able to generate documentation in
>> various formats. This means that we can start to consolidate our OFBiz
>> documentation within OFBiz itself and adapt it to any new releases.
>>
>> Feedback to the proposal have been very positive and once the code is
>> moved into our current trunk we will need to start some documentation work.
>> We will be looking for volunteers to become part of a documentation team
>> that will work on reviewing the documents we already have in the wiki and
>> other sources, then help to re-structure them to fit into the new
>> documentation framework model.
>>
>> Being involved with documentation is a good way to learn OFBiz :-)
>>
>> So if you are interested in being part of the OFBiz documentation team
>> then please respond to this message and I will add you to the list.
>>
>> Thanks
>> Sharan
>>
>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Pranay Pandey-3
In reply to this post by Michael Brohl-3
Hi Sharan,

Please count me in.

Best regards,

Pranay Pandey
www.hotwaxsystems.com
www.hotwax.co

On Thu, Feb 8, 2018 at 1:59 PM, Michael Brohl <[hidden email]>
wrote:

> Hi Sharan,
>
> please add me to the list :-)
>
> Regards,
>
> Michael
>
> Am 07.02.18 um 14:32 schrieb Sharan Foga:
>
> Hi Everyone
>>
>> (Trying again as my first post didn't reach this list)
>>
>> If you have read the latest project blog post then you will have seen a
>> section about the discussions that have been happening on our development
>> list about the new proposed OFBiz documentation framework.
>>
>> https://s.apache.org/VfxE
>>
>> It is based on asciidoc and will be able to generate documentation in
>> various formats. This means that we can start to consolidate our OFBiz
>> documentation within OFBiz itself and adapt it to any new releases.
>>
>> Feedback to the proposal have been very positive and once the code is
>> moved into our current trunk we will need to start some documentation work.
>> We will be looking for volunteers to become part of a documentation team
>> that will work on reviewing the documents we already have in the wiki and
>> other sources, then help to re-structure them to fit into the new
>> documentation framework model.
>>
>> Being involved with documentation is a good way to learn OFBiz :-)
>>
>> So if you are interested in being part of the OFBiz documentation team
>> then please respond to this message and I will add you to the list.
>>
>> Thanks
>> Sharan
>>
>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Olivier.heintz
In reply to this post by Sharan Foga
Hi Sharan,

please add me to the list,

I have start to play with the new tools
I have convert some docbook file to asciidoc with docbookrx tools and make modification on help data to use the html generated files in the ofbiz help, it's work's ;-)
If needed, I can convert all docbook files to asccidoc


Regards,



Le 07/02/2018 à 14:32, Sharan Foga a écrit :

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Aditya Sharma
Hi Sharan,

Please count me in.

Thanks and Regards,

*Aditya Sharma* | Enterprise Software Engineer
HotWax Commerce <http://www.hotwax.co/> by HotWax Systems
<http://www.hotwaxsystems.com/>

<https://www.linkedin.com/in/aditya-sharma-78291810a/>

On Thu, Feb 8, 2018 at 2:25 PM, Olivier Heintz <
[hidden email]> wrote:

> Hi Sharan,
>
> please add me to the list,
>
> I have start to play with the new tools
> I have convert some docbook file to asciidoc with docbookrx tools and make
> modification on help data to use the html generated files in the ofbiz
> help, it's work's ;-)
> If needed, I can convert all docbook files to asccidoc
>
>
> Regards,
>
>
>
> Le 07/02/2018 à 14:32, Sharan Foga a écrit :
> > Hi Everyone
> >
> > (Trying again as my first post didn't reach this list)
> >
> > If you have read the latest project blog post then you will have seen a
> section about the discussions that have been happening on our development
> list about the new proposed OFBiz documentation framework.
> >
> > https://s.apache.org/VfxE
> >
> > It is based on asciidoc and will be able to generate documentation in
> various formats. This means that we can start to consolidate our OFBiz
> documentation within OFBiz itself and adapt it to any new releases.
> >
> > Feedback to the proposal have been very positive and once the code is
> moved into our current trunk we will need to start some documentation work.
> We will be looking for volunteers to become part of a documentation team
> that will work on reviewing the documents we already have in the wiki and
> other sources, then help to re-structure them to fit into the new
> documentation framework model.
> >
> > Being involved with documentation is a good way to learn OFBiz :-)
> >
> > So if you are interested in being part of the OFBiz documentation team
> then please respond to this message and I will add you to the list.
> >
> > Thanks
> > Sharan
> >
>
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Jacques Le Roux
Administrator
In reply to this post by Sharan Foga
Hi Sharan, All,

Some time ago I created https://issues.apache.org/jira/browse/OFBIZ-9423

Not sure if we want use it in this context or if we have another new Jira more appropriate and then I close OFBIZ-9423 which is maybe too much and
confusing. I was more advocating update wiki documentation from source then.

Jacques


Le 07/02/2018 à 14:32, Sharan Foga a écrit :

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

taher
In reply to this post by Aditya Sharma
It is heartwarming to see you fine people signing up. I am thrilled
and looking forward to working with you. And I have to say Sharan
knows how to bring us together, so thank you!

In reference to Olivier's comment regarding using conversion tools, I
would advise to perhaps try to be careful. Our objective is not
necessarily to copy-paste existing documentation, but rather to write
clean, relevant and well thought out documentation. If an old piece of
documentation is good and relevant, we use it, if not, we update it
and clean it, or of it is not useful then we just drop it.

I hope more people feel the urge to sign up. What you folks are going
to achieve is to make OFBiz much more competitive by giving
accessibility to new comers through comprehensive documentation.

On Thu, Feb 8, 2018 at 1:04 PM, Aditya Sharma
<[hidden email]> wrote:

> Hi Sharan,
>
> Please count me in.
>
> Thanks and Regards,
>
> *Aditya Sharma* | Enterprise Software Engineer
> HotWax Commerce <http://www.hotwax.co/> by HotWax Systems
> <http://www.hotwaxsystems.com/>
>
> <https://www.linkedin.com/in/aditya-sharma-78291810a/>
>
> On Thu, Feb 8, 2018 at 2:25 PM, Olivier Heintz <
> [hidden email]> wrote:
>
>> Hi Sharan,
>>
>> please add me to the list,
>>
>> I have start to play with the new tools
>> I have convert some docbook file to asciidoc with docbookrx tools and make
>> modification on help data to use the html generated files in the ofbiz
>> help, it's work's ;-)
>> If needed, I can convert all docbook files to asccidoc
>>
>>
>> Regards,
>>
>>
>>
>> Le 07/02/2018 à 14:32, Sharan Foga a écrit :
>> > Hi Everyone
>> >
>> > (Trying again as my first post didn't reach this list)
>> >
>> > If you have read the latest project blog post then you will have seen a
>> section about the discussions that have been happening on our development
>> list about the new proposed OFBiz documentation framework.
>> >
>> > https://s.apache.org/VfxE
>> >
>> > It is based on asciidoc and will be able to generate documentation in
>> various formats. This means that we can start to consolidate our OFBiz
>> documentation within OFBiz itself and adapt it to any new releases.
>> >
>> > Feedback to the proposal have been very positive and once the code is
>> moved into our current trunk we will need to start some documentation work.
>> We will be looking for volunteers to become part of a documentation team
>> that will work on reviewing the documents we already have in the wiki and
>> other sources, then help to re-structure them to fit into the new
>> documentation framework model.
>> >
>> > Being involved with documentation is a good way to learn OFBiz :-)
>> >
>> > So if you are interested in being part of the OFBiz documentation team
>> then please respond to this message and I will add you to the list.
>> >
>> > Thanks
>> > Sharan
>> >
>>
>>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Michael Brohl-3
+++1 for manually reviewing, updating, restructuring and enhancing the
documentation instead of copy & paste!

We know that the documentation has very different quality, is sometimes
outdated or too brief etc.

I think it is of more value to take the chance to make the documentation
itself better in the course of the migration instead of simply having
the old state in a new format.

We should maybe also agree on writing new documentation (or anhancing a
good amount of documentation) directly in the new format instead of
putting it in confluence 8if applicable)?

Thanks,

Michael


Am 08.02.18 um 11:33 schrieb Taher Alkhateeb:

> It is heartwarming to see you fine people signing up. I am thrilled
> and looking forward to working with you. And I have to say Sharan
> knows how to bring us together, so thank you!
>
> In reference to Olivier's comment regarding using conversion tools, I
> would advise to perhaps try to be careful. Our objective is not
> necessarily to copy-paste existing documentation, but rather to write
> clean, relevant and well thought out documentation. If an old piece of
> documentation is good and relevant, we use it, if not, we update it
> and clean it, or of it is not useful then we just drop it.
>
> I hope more people feel the urge to sign up. What you folks are going
> to achieve is to make OFBiz much more competitive by giving
> accessibility to new comers through comprehensive documentation.
>
> On Thu, Feb 8, 2018 at 1:04 PM, Aditya Sharma
> <[hidden email]> wrote:
>> Hi Sharan,
>>
>> Please count me in.
>>
>> Thanks and Regards,
>>
>> *Aditya Sharma* | Enterprise Software Engineer
>> HotWax Commerce <http://www.hotwax.co/> by HotWax Systems
>> <http://www.hotwaxsystems.com/>
>>
>> <https://www.linkedin.com/in/aditya-sharma-78291810a/>
>>
>> On Thu, Feb 8, 2018 at 2:25 PM, Olivier Heintz <
>> [hidden email]> wrote:
>>
>>> Hi Sharan,
>>>
>>> please add me to the list,
>>>
>>> I have start to play with the new tools
>>> I have convert some docbook file to asciidoc with docbookrx tools and make
>>> modification on help data to use the html generated files in the ofbiz
>>> help, it's work's ;-)
>>> If needed, I can convert all docbook files to asccidoc
>>>
>>>
>>> Regards,
>>>
>>>
>>>
>>> Le 07/02/2018 à 14:32, Sharan Foga a écrit :
>>>> Hi Everyone
>>>>
>>>> (Trying again as my first post didn't reach this list)
>>>>
>>>> If you have read the latest project blog post then you will have seen a
>>> section about the discussions that have been happening on our development
>>> list about the new proposed OFBiz documentation framework.
>>>> https://s.apache.org/VfxE
>>>>
>>>> It is based on asciidoc and will be able to generate documentation in
>>> various formats. This means that we can start to consolidate our OFBiz
>>> documentation within OFBiz itself and adapt it to any new releases.
>>>> Feedback to the proposal have been very positive and once the code is
>>> moved into our current trunk we will need to start some documentation work.
>>> We will be looking for volunteers to become part of a documentation team
>>> that will work on reviewing the documents we already have in the wiki and
>>> other sources, then help to re-structure them to fit into the new
>>> documentation framework model.
>>>> Being involved with documentation is a good way to learn OFBiz :-)
>>>>
>>>> So if you are interested in being part of the OFBiz documentation team
>>> then please respond to this message and I will add you to the list.
>>>> Thanks
>>>> Sharan
>>>>
>>>


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Dennis Balkir
In reply to this post by Sharan Foga
Hi Sharan,

please add me to the list.

Thanks
Dennis Balkir

On 2018/02/07 13:32:56, Sharan Foga <[hidden email]> wrote:

> Hi Everyone>
>
> (Trying again as my first post didn't reach this list)>
>
> If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.>
>
> https://s.apache.org/VfxE>
>
> It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.>
>
> Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.>
>
> Being involved with documentation is a good way to learn OFBiz :-)>
>
> So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.>
>
> Thanks>
> Sharan>
>  


--
Dennis Balkir
Trainee

Fon +49 521 448 157-90
Fax +49 521 448 157-99

Company and Management Headquarters:
ecomify GmbH, Gustav-Winkler-Str. 22, 33699 Bielefeld, Deutschland
Fon: +49 521 448157-90, Fax: +49 521 448157-99, www.ecomify.de

Court Registration: Amtsgericht Bielefeld HRB 41683
Chief Executive Officer: Martin Becker, Michael Brohl

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Jacques Le Roux
Administrator
In reply to this post by Michael Brohl-3
I agree, actually as experience learned us, to create a good documentation is more a question of structuring the documentation to avoid what we have
now in Confluence: a mess with a lot of obsolete (or hard to tell) pages :D

By using asciidoc, a version control tools to have the documentation as OFBiz code it should be easier to avoid that.

I note though that it's all about reviewing, it was already possible in Confluence but it did not work because it was harder to follow, organise and
structure.

I think we already agreed about using Confluence as less as possible. Mostly for important generic points like Guides, FAQ, Tutos, etc.

In Confluence we can also import data from svn, it's already used for some specific stuff like Gradle.

I use https://svn.apache.org/repos/asf/ofbiz/tools/updateWiki.bat for that, not sure it's the best way, but for now it helps. The basic idea is to
have a SPOF (ie only one place for the source).

So we could for instance migrate, after cleaning and deleting a lot, the important Confluence content to keep in a main documentation sub-dir (under
OFBiz root) under a format or another and render it automatically in HTML format to import into Confluence

I read that some projects use o want to use BuibBot/Jenkins and https://jekyllrb.com/ for doing somehow that

Just an idea...

Jacques


Le 08/02/2018 à 14:25, Michael Brohl a écrit :

> +++1 for manually reviewing, updating, restructuring and enhancing the documentation instead of copy & paste!
>
> We know that the documentation has very different quality, is sometimes outdated or too brief etc.
>
> I think it is of more value to take the chance to make the documentation itself better in the course of the migration instead of simply having the
> old state in a new format.
>
> We should maybe also agree on writing new documentation (or anhancing a good amount of documentation) directly in the new format instead of putting
> it in confluence 8if applicable)?
>
> Thanks,
>
> Michael
>
>
> Am 08.02.18 um 11:33 schrieb Taher Alkhateeb:
>> It is heartwarming to see you fine people signing up. I am thrilled
>> and looking forward to working with you. And I have to say Sharan
>> knows how to bring us together, so thank you!
>>
>> In reference to Olivier's comment regarding using conversion tools, I
>> would advise to perhaps try to be careful. Our objective is not
>> necessarily to copy-paste existing documentation, but rather to write
>> clean, relevant and well thought out documentation. If an old piece of
>> documentation is good and relevant, we use it, if not, we update it
>> and clean it, or of it is not useful then we just drop it.
>>
>> I hope more people feel the urge to sign up. What you folks are going
>> to achieve is to make OFBiz much more competitive by giving
>> accessibility to new comers through comprehensive documentation.
>>
>> On Thu, Feb 8, 2018 at 1:04 PM, Aditya Sharma
>> <[hidden email]> wrote:
>>> Hi Sharan,
>>>
>>> Please count me in.
>>>
>>> Thanks and Regards,
>>>
>>> *Aditya Sharma* | Enterprise Software Engineer
>>> HotWax Commerce <http://www.hotwax.co/> by HotWax Systems
>>> <http://www.hotwaxsystems.com/>
>>>
>>> <https://www.linkedin.com/in/aditya-sharma-78291810a/>
>>>
>>> On Thu, Feb 8, 2018 at 2:25 PM, Olivier Heintz <
>>> [hidden email]> wrote:
>>>
>>>> Hi Sharan,
>>>>
>>>> please add me to the list,
>>>>
>>>> I have start to play with the new tools
>>>> I have convert some docbook file to asciidoc with docbookrx tools and make
>>>> modification on help data to use the html generated files in the ofbiz
>>>> help, it's work's ;-)
>>>> If needed, I can convert all docbook files to asccidoc
>>>>
>>>>
>>>> Regards,
>>>>
>>>>
>>>>
>>>> Le 07/02/2018 à 14:32, Sharan Foga a écrit :
>>>>> Hi Everyone
>>>>>
>>>>> (Trying again as my first post didn't reach this list)
>>>>>
>>>>> If you have read the latest project blog post then you will have seen a
>>>> section about the discussions that have been happening on our development
>>>> list about the new proposed OFBiz documentation framework.
>>>>> https://s.apache.org/VfxE
>>>>>
>>>>> It is based on asciidoc and will be able to generate documentation in
>>>> various formats. This means that we can start to consolidate our OFBiz
>>>> documentation within OFBiz itself and adapt it to any new releases.
>>>>> Feedback to the proposal have been very positive and once the code is
>>>> moved into our current trunk we will need to start some documentation work.
>>>> We will be looking for volunteers to become part of a documentation team
>>>> that will work on reviewing the documents we already have in the wiki and
>>>> other sources, then help to re-structure them to fit into the new
>>>> documentation framework model.
>>>>> Being involved with documentation is a good way to learn OFBiz :-)
>>>>>
>>>>> So if you are interested in being part of the OFBiz documentation team
>>>> then please respond to this message and I will add you to the list.
>>>>> Thanks
>>>>> Sharan
>>>>>
>>>>
>
>

--

Jacques Le Roux
400E Chemin de la Mouline
34560 Poussan
04 67 51 19 38
06 11 79 50 28

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Jacques Le Roux
Administrator
In reply to this post by Dennis Balkir
Hi Dennis,

Someone moderated your email, please subscribe to the user ML

Thanks

Jacques


Le 08/02/2018 à 15:03, Dennis Balkir a écrit :

> Hi Sharan,
>
> please add me to the list.
>
> Thanks
> Dennis Balkir
>
> On 2018/02/07 13:32:56, Sharan Foga <[hidden email]> wrote:
>> Hi Everyone>
>>
>> (Trying again as my first post didn't reach this list)>
>>
>> If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.>
>>
>> https://s.apache.org/VfxE>
>>
>> It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.>
>>
>> Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.>
>>
>> Being involved with documentation is a good way to learn OFBiz :-)>
>>
>> So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.>
>>
>> Thanks>
>> Sharan>
>>  
>

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Dennis Balkir
In reply to this post by Sharan Foga
Hi Jacques,

I actually did after sending the mail

Sorry for the inconvenience!

Thanks
Dennis

On 2018/02/08 14:46:02, Jacques Le Roux <[hidden email]> wrote:

> Hi Dennis,>
>
> Someone moderated your email, please subscribe to the user ML>
>
> Thanks>
>
> Jacques>
>
>
> Le 08/02/2018 à 15:03, Dennis Balkir a écrit :>
> > Hi Sharan,>
> >>
> > please add me to the list.>
> >>
> > Thanks>
> > Dennis Balkir>
> >>
> > On 2018/02/07 13:32:56, Sharan Foga <[hidden email]> wrote:>
> >> Hi Everyone>>
> >>>
> >> (Trying again as my first post didn't reach this list)>>
> >>>
> >> If you have read the latest project blog post then you will have seen a section about the discussions that have been happening on our development list about the new proposed OFBiz documentation framework.>>
> >>>
> >> https://s.apache.org/VfxE>>
> >>>
> >> It is based on asciidoc and will be able to generate documentation in various formats. This means that we can start to consolidate our OFBiz documentation within OFBiz itself and adapt it to any new releases.>>
> >>>
> >> Feedback to the proposal have been very positive and once the code is moved into our current trunk we will need to start some documentation work. We will be looking for volunteers to become part of a documentation team that will work on reviewing the documents we already have in the wiki and other sources, then help to re-structure them to fit into the new documentation framework model.>>
> >>>
> >> Being involved with documentation is a good way to learn OFBiz :-)>>
> >>>
> >> So if you are interested in being part of the OFBiz documentation team then please respond to this message and I will add you to the list.>>
> >>>
> >> Thanks>>
> >> Sharan>>
> >>   >
> >>
>
>  


--
Dennis Balkir
Trainee

Fon +49 521 448 157-90
Fax +49 521 448 157-99

Company and Management Headquarters:
ecomify GmbH, Gustav-Winkler-Str. 22, 33699 Bielefeld, Deutschland
Fon: +49 521 448157-90, Fax: +49 521 448157-99, www.ecomify.de

Court Registration: Amtsgericht Bielefeld HRB 41683
Chief Executive Officer: Martin Becker, Michael Brohl

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Piotr Walesiak
In reply to this post by Michael Brohl-3
Hello,

Not sure whether i can help much since i'm quite new to OFBiz. However
count me in, pls.

P.

08.02.2018 9:29 AM "Michael Brohl" <[hidden email]> napisał(a):

> Hi Sharan,
>
> please add me to the list :-)
>
> Regards,
>
> Michael
>
> Am 07.02.18 um 14:32 schrieb Sharan Foga:
>
>> Hi Everyone
>>
>> (Trying again as my first post didn't reach this list)
>>
>> If you have read the latest project blog post then you will have seen a
>> section about the discussions that have been happening on our development
>> list about the new proposed OFBiz documentation framework.
>>
>> https://s.apache.org/VfxE
>>
>> It is based on asciidoc and will be able to generate documentation in
>> various formats. This means that we can start to consolidate our OFBiz
>> documentation within OFBiz itself and adapt it to any new releases.
>>
>> Feedback to the proposal have been very positive and once the code is
>> moved into our current trunk we will need to start some documentation work.
>> We will be looking for volunteers to become part of a documentation team
>> that will work on reviewing the documents we already have in the wiki and
>> other sources, then help to re-structure them to fit into the new
>> documentation framework model.
>>
>> Being involved with documentation is a good way to learn OFBiz :-)
>>
>> So if you are interested in being part of the OFBiz documentation team
>> then please respond to this message and I will add you to the list.
>>
>> Thanks
>> Sharan
>>
>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Akash Jain
In reply to this post by Sharan Foga
Hi Sharan,

Please count me in.

Thanks and Regards
--
Akash Jain

On Wed, Feb 7, 2018 at 7:02 PM, Sharan Foga <[hidden email]> wrote:

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a
> section about the discussions that have been happening on our development
> list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in
> various formats. This means that we can start to consolidate our OFBiz
> documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is
> moved into our current trunk we will need to start some documentation work.
> We will be looking for volunteers to become part of a documentation team
> that will work on reviewing the documents we already have in the wiki and
> other sources, then help to re-structure them to fit into the new
> documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team
> then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>
Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Tarun Thakur
Hello Sharan,

Want to join in too. Don't have that much of OFBiz experience but can be helpful with my Oracle POS & Retail knowledge here. Please consider my request. 

Thanks & Regards,

Tarun Singh Thakur Business Development Representative
Mobile: +91-8826544218
www.karyonsolutions.com Building the Nucleus

On Fri, Feb 9, 2018 at 10:02 AM, Akash Jain <[hidden email]> wrote:
Hi Sharan,

Please count me in.

Thanks and Regards
--
Akash Jain

On Wed, Feb 7, 2018 at 7:02 PM, Sharan Foga <[hidden email]> wrote:

> Hi Everyone
>
> (Trying again as my first post didn't reach this list)
>
> If you have read the latest project blog post then you will have seen a
> section about the discussions that have been happening on our development
> list about the new proposed OFBiz documentation framework.
>
> https://s.apache.org/VfxE
>
> It is based on asciidoc and will be able to generate documentation in
> various formats. This means that we can start to consolidate our OFBiz
> documentation within OFBiz itself and adapt it to any new releases.
>
> Feedback to the proposal have been very positive and once the code is
> moved into our current trunk we will need to start some documentation work.
> We will be looking for volunteers to become part of a documentation team
> that will work on reviewing the documents we already have in the wiki and
> other sources, then help to re-structure them to fit into the new
> documentation framework model.
>
> Being involved with documentation is a good way to learn OFBiz :-)
>
> So if you are interested in being part of the OFBiz documentation team
> then please respond to this message and I will add you to the list.
>
> Thanks
> Sharan
>

Reply | Threaded
Open this post in threaded view
|

Re: OFBiz Documentation Team Volunteers Needed

Olivier.heintz
In reply to this post by Michael Brohl-3
good tools are tools which help to work not to (try to) replace human works. :-)

1) Conversion from docbook to asciidoc will just help us to  work on content and not on technical syntax.

2) Current ofbiz help system has some weakness but it works and, as it's easy, to update data to use it with html file generate from ascii it's a good
tools to test if some content is usable (or not) in a contextual help.
But I agree, I don't know when contextual help  will be in the task list of the Documentation team ;-)

Olivier

Le 08/02/2018 à 14:25, Michael Brohl a écrit :

> +++1 for manually reviewing, updating, restructuring and enhancing the
> documentation instead of copy & paste!
>
> We know that the documentation has very different quality, is sometimes
> outdated or too brief etc.
>
> I think it is of more value to take the chance to make the documentation
> itself better in the course of the migration instead of simply having
> the old state in a new format.
>
> We should maybe also agree on writing new documentation (or anhancing a
> good amount of documentation) directly in the new format instead of
> putting it in confluence 8if applicable)?
>
> Thanks,
>
> Michael
>
>
> Am 08.02.18 um 11:33 schrieb Taher Alkhateeb:
>> It is heartwarming to see you fine people signing up. I am thrilled
>> and looking forward to working with you. And I have to say Sharan
>> knows how to bring us together, so thank you!
>>
>> In reference to Olivier's comment regarding using conversion tools, I
>> would advise to perhaps try to be careful. Our objective is not
>> necessarily to copy-paste existing documentation, but rather to write
>> clean, relevant and well thought out documentation. If an old piece of
>> documentation is good and relevant, we use it, if not, we update it
>> and clean it, or of it is not useful then we just drop it.
>>
>> I hope more people feel the urge to sign up. What you folks are going
>> to achieve is to make OFBiz much more competitive by giving
>> accessibility to new comers through comprehensive documentation.
>>
>> On Thu, Feb 8, 2018 at 1:04 PM, Aditya Sharma
>> <[hidden email]> wrote:
>>> Hi Sharan,
>>>
>>> Please count me in.
>>>
>>> Thanks and Regards,
>>>
>>> *Aditya Sharma* | Enterprise Software Engineer
>>> HotWax Commerce <http://www.hotwax.co/> by HotWax Systems
>>> <http://www.hotwaxsystems.com/>
>>>
>>> <https://www.linkedin.com/in/aditya-sharma-78291810a/>
>>>
>>> On Thu, Feb 8, 2018 at 2:25 PM, Olivier Heintz <
>>> [hidden email]> wrote:
>>>
>>>> Hi Sharan,
>>>>
>>>> please add me to the list,
>>>>
>>>> I have start to play with the new tools
>>>> I have convert some docbook file to asciidoc with docbookrx tools and make
>>>> modification on help data to use the html generated files in the ofbiz
>>>> help, it's work's ;-)
>>>> If needed, I can convert all docbook files to asccidoc
>>>>
>>>>
>>>> Regards,
>>>>
>>>>
>>>>
>>>> Le 07/02/2018 à 14:32, Sharan Foga a écrit :
>>>>> Hi Everyone
>>>>>
>>>>> (Trying again as my first post didn't reach this list)
>>>>>
>>>>> If you have read the latest project blog post then you will have seen a
>>>> section about the discussions that have been happening on our development
>>>> list about the new proposed OFBiz documentation framework.
>>>>> https://s.apache.org/VfxE
>>>>>
>>>>> It is based on asciidoc and will be able to generate documentation in
>>>> various formats. This means that we can start to consolidate our OFBiz
>>>> documentation within OFBiz itself and adapt it to any new releases.
>>>>> Feedback to the proposal have been very positive and once the code is
>>>> moved into our current trunk we will need to start some documentation work.
>>>> We will be looking for volunteers to become part of a documentation team
>>>> that will work on reviewing the documents we already have in the wiki and
>>>> other sources, then help to re-structure them to fit into the new
>>>> documentation framework model.
>>>>> Being involved with documentation is a good way to learn OFBiz :-)
>>>>>
>>>>> So if you are interested in being part of the OFBiz documentation team
>>>> then please respond to this message and I will add you to the list.
>>>>> Thanks
>>>>> Sharan
>>>>>
>

12