Initial wiki page to help co-ordinate efforts of OFBiz Documentation team.
Team Members
Please add your details below if you would like to volunteer to help
Name | Confluence Id | Location / Timezone | Added to Skype Group |
---|---|---|---|
Sharan Foga | Sharan Foga | Prague, UTC+1 | Yes |
Olivier Heintz | Olivier Heintz | France, UTC+1 | Yes |
Deepak Nigam | Deepak Nigam | ||
Tim Boyden | Timothy Boyden | Boston, UTC-5 | |
Craig Parker | Craig Bachelor | EST (NY time), which is -5:00 GMT I think. | Yes |
Arthur Marquez | |||
Swapnil Mane | Swapnil Mane | India, UTC+5.5 | Yes |
Michael Brohl | Michael Brohl | Germany, UTC+1 | Yes |
Pranay Pandey | Pranay Pandey | India, UTC+5.5 | Yes |
Aditya Sharma | Aditya Sharma | ||
Dennis Balkir | Dennis Balkir | Germany, UTC+1 | |
Akash Jain | Akash Jain | India, UTC+5.5 | Yes |
Tarun Thakur | Tarun Singh Thakur | ||
Piotr Walesiak | |||
Giulio Speri | Giulio Speri | Italy, UTC+1 | |
Taher Alkhateeb | Taher Alkhateeb | Kuwait, UTC +3 | Yes |
Vikram Gupta | Vikram Gupta | Durban, SA, UTC+2 | |
Mauricio Tavares | UTC+1 | ||
Badar Ali | Badar Ali | Yes | |
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?
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 )
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