OFBiz › OFBiz - Dev

[jira] Created: (OFBIZ-568) Index places of existing documentation that needs to be cleaned or deleted

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

5 messages Options

Nicolas Malin (Jira)

[jira] Created: (OFBIZ-568) Index places of existing documentation that needs to be cleaned or deleted

Index places of existing documentation that needs to be cleaned or deleted
--------------------------------------------------------------------------

Key: OFBIZ-568
URL: http://issues.apache.org/jira/browse/OFBIZ-568
Project: OFBiz (The Open for Business Project)
Issue Type: Improvement
Reporter: Jacques Le Roux
Priority: Minor

In order to provide a cleaner updated documentation we need to update or even delete (when redudant or obsolete/false) existing informations in different places where the OFBiz documentation stands. Ultimatly we have to group together all this informations under the official OFBiz documentation and try to maintain it with indication when deprecated.

In a 1st step, In this issue we might put links to such informations. Here are the 1st from a thread (Properly edited OFBiz manuals) initiated by Torsten Schlabach

About setting up OFBiz :
http://ofbizwiki.go-integral.com/Wiki.jsp?page=OnlineUserManual
http://docs.ofbiz.org/display/OFBIZ/Application+Reference+for+Users
http://incubator.apache.org/ofbiz/docs/GettingAndUsingOFBiz.pdf
http://docs.ofbiz.org/display/OFBTECH/OFBiz+Basic+Production+Setup+Guide

To be continued...

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-568) Index places of existing documentation that needs to be cleaned or deleted

[ http://issues.apache.org/jira/browse/OFBIZ-568?page=comments#action_12461232 ]

Jacques Le Roux commented on OFBIZ-568:
---------------------------------------

I wish to add in the list above the OpenSourceStrategies documentation for the parts that are not OpenTaps specific. But this is maybe out of scope ?
http://downloads.sourceforge.net/opentaps/opentaps-0.9-manuals-v5.zip?modtime=1166474985&big_mirror=0

We might also think about links in this page : http://www.opentaps.org/index.php?option=com_content&task=blogcategory&id=24&Itemid=48

I believe this link is also related and should be merged with a global setup guide http://incubator.apache.org/ofbiz/docs/setup.html

Of course any complements will be greatly appreciated ;o)

> Index places of existing documentation that needs to be cleaned or deleted
> --------------------------------------------------------------------------
>
> Key: OFBIZ-568
> URL: http://issues.apache.org/jira/browse/OFBIZ-568
> Project: OFBiz (The Open for Business Project)
> Issue Type: Improvement
> Reporter: Jacques Le Roux
> Priority: Minor
>
> In order to provide a cleaner updated documentation we need to update or even delete (when redudant or obsolete/false) existing informations in different places where the OFBiz documentation stands. Ultimatly we have to group together all this informations under the official OFBiz documentation and try to maintain it with indication when deprecated.
> In a 1st step, In this issue we might put links to such informations. Here are the 1st from a thread (Properly edited OFBiz manuals) initiated by Torsten Schlabach
> About setting up OFBiz :
> http://ofbizwiki.go-integral.com/Wiki.jsp?page=OnlineUserManual
> http://docs.ofbiz.org/display/OFBIZ/Application+Reference+for+Users
> http://incubator.apache.org/ofbiz/docs/GettingAndUsingOFBiz.pdf
> http://docs.ofbiz.org/display/OFBTECH/OFBiz+Basic+Production+Setup+Guide
> To be continued...

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-568) Index places of existing documentation that needs to be cleaned or deleted

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-568?page=comments#action_12461236 ]

Jacques Le Roux commented on OFBIZ-568:
---------------------------------------

There is another POV we did not discuss in the ML thread : documentation translation ...

Neogia is a good example of existing such ressources.

Like for Opentaps there are parts that are specific to Neogia (Neogia replaces some parts of OFBiz, Opentaps only adds new parts). A good example of documentation of such replacement is http://wiki.neogia.org/Documentation_Module_Comptabilite.

But there are also some documentations usable in OFBiz and Neogia like http://wiki.neogia.org/wiki/Manuel_Fonctionnel (unfortunatly as this hour the link is broken) Actually I was the 1st writer of this documentation (also available at http://www.les7arts.com/assist/OFBiz/Creation%20Catalogue%20de%20produits.pdf) but Neogia's is normally updated by other Neogia Contributors.

So we may consider regrouping such informations under offcial OFBiz Apache. I can't tell for Neogia but for my part it will be ok ! For Neogia (for instance) maybe a link would be appreciated ?

I know that Neogia and Opentaps are GPL but I don't think it's the same for their documentations.

I hope I have not been too forward in this comment. Anyway if it's the case I might consider to delete it.

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-568) Index places of existing documentation that needs to be cleaned or deleted

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-568?page=comments#action_12461278 ]

David E. Jones commented on OFBIZ-568:
--------------------------------------

This is a good effort and I'm glad it has started with an effort to review existing documentation. As I mentioned on the mailing list the goal since earlier this year when the docs.ofbiz.org site was created is to consolidate all documentation there.

Please note that there are areas that are intentionally open, namely the OFBIZ space, and places that are meant to be controller by documentation moderators, namely the OFBTECH and OFBENDUSER spaces. Permission is required to work in these areas and we need volunteers, or more specifically we need _active_ volunteers. There is also an OFBADMIN space for documents and information related to the development and administration of OFBiz.

The OFBIZ space (the open access wiki area) is meant to be a staging ground of whatever people want to put there and will never likely be well organized. Documentation volunteers should pull resources from there and credit them, just as with comments on pages in the OFBTECH and OFBENDUSER spaces, and work them into the existing "moderated" documentation structure.

Anyone getting involved should review the history. For example, the "Application Reference for Users" page in the OFBIZ space is a place holder for the documents being migrated from the old Undersun end-user documentation site. All of the documents from that site are available as PDFs attached to this page:

http://docs.ofbiz.org/x/5gI

Note that SOME of these have already been moved over and are under the OFBiz End User Docs Home page at:

http://docs.ofbiz.org/x/Bw

Just go to that link and use the "view in hierarchy" link to browse around them. That is the target and the organization so far for the end-user documentation.

Nicolas Malin (Jira)

[jira] Assigned: (OFBIZ-568) Index places of existing documentation that needs to be cleaned or deleted

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-568?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jacques Le Roux reassigned OFBIZ-568:
-------------------------------------

Assignee: Jacques Le Roux

> Index places of existing documentation that needs to be cleaned or deleted
> --------------------------------------------------------------------------
>
> Key: OFBIZ-568
> URL: http://issues.apache.org/jira/browse/OFBIZ-568
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Improvement
> Reporter: Jacques Le Roux
> Assigned To: Jacques Le Roux
> Priority: Minor
>
> In order to provide a cleaner updated documentation we need to update or even delete (when redudant or obsolete/false) existing informations in different places where the OFBiz documentation stands. Ultimatly we have to group together all this informations under the official OFBiz documentation and try to maintain it with indication when deprecated.
> In a 1st step, In this issue we might put links to such informations. Here are the 1st from a thread (Properly edited OFBiz manuals) initiated by Torsten Schlabach
> About setting up OFBiz :
> http://ofbizwiki.go-integral.com/Wiki.jsp?page=OnlineUserManual
> http://docs.ofbiz.org/display/OFBIZ/Application+Reference+for+Users
> http://incubator.apache.org/ofbiz/docs/GettingAndUsingOFBiz.pdf
> http://docs.ofbiz.org/display/OFBTECH/OFBiz+Basic+Production+Setup+Guide
> To be continued...