Access to add and change pages is restricted. See: https://cwiki.apache.org/confluence/display/OFBIZ/Wiki+access

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 37 Next »

Initial wiki page to help co-ordinate efforts of OFBiz Documentation team.

Feb2018MarAprMayJunJulAugSepOctNovDecJan2019Marker 1
Lane 1
Lane 2

Bar 1

Bar 2

Bar 3

Team Members

Please add your details below if you would like to volunteer to help

NameConfluence IdLocation / TimezoneAdded to Skype Group
Sharan FogaSharan FogaPrague, UTC+1Yes
Olivier HeintzOlivier HeintzFrance, UTC+1Yes
Deepak Nigam
Deepak Nigam  
Tim BoydenTimothy BoydenBoston, UTC-5 
Craig ParkerCraig BachelorEST (NY time), which is -5:00 GMT I think.Yes
Arthur Marquez   
Swapnil ManeSwapnil ManeIndia, UTC+5.5Yes
Michael BrohlMichael BrohlGermany, UTC+1Yes
Pranay PandeyPranay PandeyIndia, UTC+5.5Yes
Aditya SharmaAditya Sharma  
Dennis Balkir Dennis BalkirGermany, UTC+1 
Akash JainAkash JainIndia, UTC+5.5Yes
Tarun ThakurTarun Singh Thakur Yes
Piotr Walesiak   
Giulio SperiGiulio SperiItaly, UTC+1 
Taher AlkhateebTaher AlkhateebKuwait, UTC +3Yes
Vikram GuptaVikram GuptaDurban, SA, UTC+2 
Mauricio Tavares 
UTC+1
 
Badar AliBadar Ali Yes
Allan Zarsuela   
    

Initial  Team Setup Tasks

  • Ensure all team members have ICLAs filed (Started 13/02/18 In progress) 
  • Collect all Confluence and JIRA ids and ensure contributor permissions are setup (Started 13/02/18 and in progress)
  • Skype call to talk about how to get started :

 

Brainstorming Ideas

How to get started with planning and organisation?

  • Define a table of contents of the documentation that we want to produce and use it as the document structure within OFBiz.
  • Define target (ordered) for documentation reader and usage (contextual help screen or function or component or "README" by component, function, process, or book or ...)

We want documents to be small and focussed on one topic (this will make it more re-usable).

We don't want to just copy and paste what we already have

We have a complete HR manual - could we use it as a first set of documents  to all work on together?

We can start, in the same time as other documents, the "how to write documentation" page/section to be able to  share

  • how to use asciidoc syntax for specifics situation
  • rules for trying to be homogeneous 

     At the beginning this page will be more a draft than a documentation but it can be help us to see if our documentation is usable by us (smile)

Doing a small modification on showHelp view to have a header with a link a the main manual (which have links to all the other files (wink))

Questions

How to test a process documentation, related (or not) with demo data ? (where to put source asccidoc files, how to arrive on it)

Which collaborations tools : jira, branch, github and with which rules

How the reader can search on multiple help files ?

How to be able to manage multi-language ? it's not a priority for ofbiz trunk but should be available on customer site (currently it's manage by content multi-language capabilities) 

 

Tasks / actions available

Automatic translation for one file from docbook to asciidoc

 

 

  • No labels