You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@openoffice.apache.org by Stuart <De...@web.de> on 2013/01/20 15:06:05 UTC

[www] Want to add documentation to http://www.openoffice.org/udk/ or http://wiki.openoffice.org/wiki/Uno/

Hello everybody,

my name is Stefan Ensslen. I'm a 34 years old software engineer from
Germany. I'd like to participate in the documentation of
OpenOffice/LibreOffice. However, I'd rather contribute to the
Programmer's instead of the User's Guide.

I found that the framework documentation
(http://docs.libreoffice.org/framework.html) contains only a single
link to the OO site (http://wiki.openoffice.org/wiki/Framework), and
the information that can be found at the OO site seems to be only a
stub. I can't imagine that everybody just reads the source code in
order to find out how UNO works, so I'd like to add some information.

The UNO documentation does not offer more insights either. Both sites
http://www.openoffice.org/udk/ and http://wiki.openoffice.org/wiki/Uno/
offer much information about the concepts of UNO.

Besides this, I'd also like to add some information about how one can
contribute to the Programmer's Guide. I'd be happy to contribute, but
unfortunately neither LibreOffice nor OpenOffice make it easy to
contribute (unlike Wikipedia).

So I guess that I have to apply for some kind of account.

Thanks in advance,
Stefan Ensslen





Re: [www] Want to add documentation to http://www.openoffice.org/udk/ or http://wiki.openoffice.org/wiki/Uno/

Posted by Regina Henschel <rb...@t-online.de>.
Hi Stefan,

welcome to the AOO project. We have the documentation mailing list, see 
http://openoffice.apache.org/mailing-lists.html#documentation-mailing-list-public. 
You should subscribe to that list too.

Stuart schrieb:
> Hello everybody,
>
> my name is Stefan Ensslen. I'm a 34 years old software engineer from
> Germany. I'd like to participate in the documentation of
> OpenOffice/LibreOffice. However, I'd rather contribute to the
> Programmer's instead of the User's Guide.

Do you want to write in English or in German or both?

Documentation lies idle for some time and we look forward to your 
contribution. It would fit well to our effort to attract more developers.

>
> I found that the framework documentation
> (http://docs.libreoffice.org/framework.html) contains only a single
> link to the OO site (http://wiki.openoffice.org/wiki/Framework), and
> the information that can be found at the OO site seems to be only a
> stub. I can't imagine that everybody just reads the source code in
> order to find out how UNO works, so I'd like to add some information.
>
> The UNO documentation does not offer more insights either. Both sites
> http://www.openoffice.org/udk/ and http://wiki.openoffice.org/wiki/Uno/
> offer much information about the concepts of UNO.
>
> Besides this, I'd also like to add some information about how one can
> contribute to the Programmer's Guide. I'd be happy to contribute, but
> unfortunately neither LibreOffice nor OpenOffice make it easy to
> contribute (unlike Wikipedia).
>
> So I guess that I have to apply for some kind of account.

Our documentation will be on http://wiki.openoffice.org/wiki/Main_Page, 
here called "MWiki". The MWiki-software is the same as for Wikipedia. 
You register for an account and write then. To minimize spam, persons 
with a new account have to wait four days till write access is enabled. 
So please be patient.

We encourage new volunteers to learn a little bit about the project 
itself. Please have a look at 
http://openoffice.apache.org/orientation/index.html

Kind regards
Regina


Re: [www] Want to add documentation to http://www.openoffice.org/udk/ or http://wiki.openoffice.org/wiki/Uno/

Posted by Stuart <De...@web.de>.
Am 21.01.13 00:33, schrieb Alexandro Colorado:
> On Sun, Jan 20, 2013 at 8:06 AM, Stuart <De...@web.de> wrote:
>
>> Hello everybody,
>>
>> my name is Stefan Ensslen. I'm a 34 years old software engineer from
>> Germany. I'd like to participate in the documentation of
>> OpenOffice/LibreOffice. However, I'd rather contribute to the
>> Programmer's instead of the User's Guide.
>>
>> I found that the framework documentation
>> (http://docs.libreoffice.org/**framework.html<http://docs.libreoffice.org/framework.html>)
>> contains only a single
>> link to the OO site (http://wiki.openoffice.org/**wiki/Framework<http://wiki.openoffice.org/wiki/Framework>),
>> and
>> the information that can be found at the OO site seems to be only a
>> stub. I can't imagine that everybody just reads the source code in
>> order to find out how UNO works, so I'd like to add some information.
>>
>> The UNO documentation does not offer more insights either. Both sites
>> http://www.openoffice.org/udk/ and http://wiki.openoffice.org/**wiki/Uno/<http://wiki.openoffice.org/wiki/Uno/>
>> offer much information about the concepts of UNO.
>>
>> Besides this, I'd also like to add some information about how one can
>> contribute to the Programmer's Guide. I'd be happy to contribute, but
>> unfortunately neither LibreOffice nor OpenOffice make it easy to
>> contribute (unlike Wikipedia).
>>
>> So I guess that I have to apply for some kind of account.
>>
>> Thanks in advance,
>> Stefan Ensslen
>>
>>
>>
>>
>>
> Hi Stefan,
>
> Most of these projects were intended to have some documentation but not
> meant to become a documentation site fo their target, these are mainly
> development project. So the target wasnt to teach users to learn the
> component but to hack on it.
>
> That said, the documenation project does need to get more development
> documenation set in place. If you look at some wiki documentationyou will
> notice some alerts, notes and request for update.
>
> Wikis are as easy to contribute as wikipedia, just create an account, go to
> oen of these documents and update the page.
>
> The actual site is a bit harder to contribute because you need to become an
> apache contributor to edit, but mailing lists are set in place to work with
> a contributor to get your commit submited. Just pull the site code, make
> the update, and send the diff. Or generate a bug on the www component and
> attach the patch.
>
> This is how most of the open source projects work.
>
> so:
> create account wiki:
> http://wiki.openoffice.org/w/index.php?title=Special:UserLogin&returnto=Special%3ASearch&returntoquery=search%3DUDK%26go%3DGo&type=signup
> Apache bugzilla: https://issues.apache.org/ooo/
> UDK site source:
> http://svn.apache.org/viewvc/openoffice/ooo-site/trunk/content/udk/
>

Many thanks,
Stefan


Re: [www] Want to add documentation to http://www.openoffice.org/udk/ or http://wiki.openoffice.org/wiki/Uno/

Posted by Alexandro Colorado <jz...@oooes.org>.
On Sun, Jan 20, 2013 at 8:06 AM, Stuart <De...@web.de> wrote:

> Hello everybody,
>
> my name is Stefan Ensslen. I'm a 34 years old software engineer from
> Germany. I'd like to participate in the documentation of
> OpenOffice/LibreOffice. However, I'd rather contribute to the
> Programmer's instead of the User's Guide.
>
> I found that the framework documentation
> (http://docs.libreoffice.org/**framework.html<http://docs.libreoffice.org/framework.html>)
> contains only a single
> link to the OO site (http://wiki.openoffice.org/**wiki/Framework<http://wiki.openoffice.org/wiki/Framework>),
> and
> the information that can be found at the OO site seems to be only a
> stub. I can't imagine that everybody just reads the source code in
> order to find out how UNO works, so I'd like to add some information.
>
> The UNO documentation does not offer more insights either. Both sites
> http://www.openoffice.org/udk/ and http://wiki.openoffice.org/**wiki/Uno/<http://wiki.openoffice.org/wiki/Uno/>
> offer much information about the concepts of UNO.
>
> Besides this, I'd also like to add some information about how one can
> contribute to the Programmer's Guide. I'd be happy to contribute, but
> unfortunately neither LibreOffice nor OpenOffice make it easy to
> contribute (unlike Wikipedia).
>
> So I guess that I have to apply for some kind of account.
>
> Thanks in advance,
> Stefan Ensslen
>
>
>
>
>
Hi Stefan,

Most of these projects were intended to have some documentation but not
meant to become a documentation site fo their target, these are mainly
development project. So the target wasnt to teach users to learn the
component but to hack on it.

That said, the documenation project does need to get more development
documenation set in place. If you look at some wiki documentationyou will
notice some alerts, notes and request for update.

Wikis are as easy to contribute as wikipedia, just create an account, go to
oen of these documents and update the page.

The actual site is a bit harder to contribute because you need to become an
apache contributor to edit, but mailing lists are set in place to work with
a contributor to get your commit submited. Just pull the site code, make
the update, and send the diff. Or generate a bug on the www component and
attach the patch.

This is how most of the open source projects work.

so:
create account wiki:
http://wiki.openoffice.org/w/index.php?title=Special:UserLogin&returnto=Special%3ASearch&returntoquery=search%3DUDK%26go%3DGo&type=signup
Apache bugzilla: https://issues.apache.org/ooo/
UDK site source:
http://svn.apache.org/viewvc/openoffice/ooo-site/trunk/content/udk/

-- 
Alexandro Colorado
Apache OpenOffice Contributor
http://es.openoffice.org

Re: [www] Want to add documentation to http://www.openoffice.org/udk/ or http://wiki.openoffice.org/wiki/Uno/

Posted by Stuart <De...@web.de>.
Stuart schrieb:
>> Hello everybody,
>>
>> my name is Stefan Ensslen. I'm a 34 years old software engineer from
>> Germany. I'd like to participate in the documentation of
>> OpenOffice/LibreOffice. However, I'd rather contribute to the
>> Programmer's instead of the User's Guide.

On 01/20/2013 Regina Henschel wrote:
 > Hi Stefan,
 >
 > welcome to the AOO project. We have the documentation mailing list,
 > see
 > http://openoffice.apache.org/mailing-lists.html#documentation-
 > mailing-list-public.
 > You should subscribe to that list too.
 >
 >
> Do you want to write in English or in German or both?

As I want to start with the Programmer's Guide I will only write in English.

> Documentation lies idle for some time and we look forward to your
> contribution. It would fit well to our effort to attract more developers.

Stuart schrieb:
>> I found that the framework documentation
>> (http://docs.libreoffice.org/framework.html) contains only a single
>> link to the OO site (http://wiki.openoffice.org/wiki/Framework), and
>> the information that can be found at the OO site seems to be only a
>> stub. I can't imagine that everybody just reads the source code in
>> order to find out how UNO works, so I'd like to add some information.
>>
>> The UNO documentation does not offer more insights either. Both sites
>> http://www.openoffice.org/udk/ and http://wiki.openoffice.org/wiki/Uno/
>> offer much information about the concepts of UNO.
>>
>> Besides this, I'd also like to add some information about how one can
>> contribute to the Programmer's Guide. I'd be happy to contribute, but
>> unfortunately neither LibreOffice nor OpenOffice make it easy to
>> contribute (unlike Wikipedia).
>>
>> So I guess that I have to apply for some kind of account.

On 01/20/2013 Regina Henschel wrote:
> Our documentation will be on http://wiki.openoffice.org/wiki/Main_Page,
> here called "MWiki".

OK. I already found that http://www.openoffice.org/udk/ should be 
transferred to http://wiki.openoffice.org in 
http://wiki.openoffice.org/wiki/Uno ("It is planned to move most content 
from the http://udk.openoffice.org pages into the Wiki."). However, the 
http://www.openoffice.org/udk/ does not advertise this transition. I 
don't know how one can change http://www.openoffice.org/udk/. Maybe you 
can give me a clue?

Apart from that I found this page:
http://www.openoffice.org/udk/common/man/uno.html
which contains some statements about why the OpenOffice team decided to 
implement their own Component Framework instead of using one of the 
exisiting frameworks like COM or CORBA. However, I did not find any way 
to get from the main page http://www.openoffice.org/udk to
http://www.openoffice.org/udk/common/man/uno.html
If I hadn't used Google, I would never have found this page ;-(



Futhermore I realized that large amount of information about UNO can be 
found under 
http://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide

IMHO, this page should be more accessable (I have only found the 
following way to get to this page:
1.) http://www.openoffice.org
    -> click "I want to participate"
2.) http://openoffice.apache.org/get-involved.html
    -> I would expect another page where I can chose
       between
        - User's Manual
        - Source code
        - Programmer's Manual
        - Distribution
     Instead I have to scroll down almost to the end and click on
     "New Volunteer Orientation"
3.) I have to click all the links. Under
     "Available Orientation Modules"
       -> "Level 3: Introductory Specialized Areas"
          -> "(Draft)Introduction to Development"
4.) http://openoffice.apache.org/orientation/intro-development.html
     I finally got one step closer to the Programmer's Manual. However,
     I still have to scroll down two pages until I get to "Other
     sources". Voila, I found
     http://wiki.openoffice.org/wiki/Documentation/DevGuide
          /OpenOffice.org_Developers_Guide


So far I have found three places where information about UNO is stored.
One of them is declared as dead and should be transferred.
However, it would be good to find a single place where this information 
should be stored. I don't want to overthrow any established procedures 
in these matters.


> The MWiki-software is the same as for Wikipedia.
> You register for an account and write then. To minimize spam, persons
> with a new account have to wait four days till write access is enabled.
> So please be patient.

Thanks,
Stefan