Hi All Huge thanks very much to everyone who participated in the Skype call today. It's great to meet new people in the community wanting to help out and contribute. I'll write up the notes from the meeting and post them here and on the wiki.
Thanks Sharan On 2018/02/27 11:30:18, Taher Alkhateeb <slidingfilame...@gmail.com> wrote: > Hi Sharan, > > On my part, the agenda of items i'd like to discuss includes: > - an overview and orientation of the documentation framework > - some guidelines and recommendations for technical writing > - OFBiz specific design considerations > - Tools and resources > > In a sense, my agenda is a bit abstract because perhaps setting the ground > work would help in elaborating and brainstorming once people understand > exactly how their ideas should fit within the framework. > > On Feb 27, 2018 2:13 PM, "Sharan Foga" <sha...@apache.org> wrote: > > > Hi All > > > > have a few ideas, I wanted to share in preparation for the call too (and > > I'm in agreement with Michael and Taher's suggestions so far) : > > > > - To get started we need to focus on co-ordination, structure and > > organisation (we have a lot of people wanting to contribute but their > > efforts need to be co-ordinated > > - We need a visual high level plan (see example roadmap above) so that > > everyone can quickly see progress and main milestones > > - We need to define the scope of the effort (maybe do this by saying what > > we are not going to do??, eg. not an FAQ, not a tutorial, not a use case, > > not a cookbook) so will be feature documentation (i.e. describing what we > > have available) > > - We can look at using JIRA as main co-ordination and tracking tool. We > > could look at using a new label eg 'documentation' in conjunction with the > > existing components. Maybe update workflow to have a new QA status ? > > Is the assumption that the work will be done in the trunk ? (since 17.12 > > branch already created). This will mean that it become part of the 18.xx > > branch. Do we look at backporting to 17.12 ??? > > - Look at some ways to get started working together. One idea could be > > that we all work together creating the documentation for one component (My > > suggestion would be HR since a complete HR manual already exists. It will > > need a full review and maybe rewrite in parts but the main content is > > already there. Each person could be allocated an area and be responsible > > for submitting a patch > > > > These are some of my brainstorming ideas :-) and I look forward to > > chatting with those of you planning to be on the call later today. > > > > Thanks > > Sharan > > > > > > On 2018/02/24 15:32:04, Taher Alkhateeb <slidingfilame...@gmail.com> > > wrote: > > > it would've been great if you could join us. One of the points I had > > > in my agenda is to suggest having the experienced people in the team > > > volunteer for mentorship to anyone wanting it from the documentation > > > team. This would help put structure and coordinate efforts in this big > > > team of contributors. > > > > > > So in reply to your thoughts above, yes I believe you and the other > > > experienced developers would be instrumental in coordination and > > > provision of structure for the rest of the team. My role would perhaps > > > mostly be to update the documentation system code as per the evolving > > > needs of the documentation team and to help with any technical / > > > support issues. > > > > > > On Sat, Feb 24, 2018 at 6:06 PM, Michael Brohl <michael.br...@ecomify.de> > > wrote: > > > > Hi Sharan, all, > > > > > > > > I most likely cannot attend the Skype call so I will add some thoughts > > here. > > > > > > > > I think we should set up a small documentation quality team which is > > > > responsible that the documentation send in by contributors is of good > > > > quality, consistent and (mostly) error free. This team should also > > propose > > > > the structure of the documentation and maybe add the empty .adoc files > > and > > > > includes to lead the way for contributors. > > > > > > > > I'd volunteer to be part of this team. > > > > > > > > It could also be a good idea to track who is working on a piece of > > > > documentation to avoid double work and encourage collaboration between > > > > contributors interested in the same topic(s). I think this might be > > Jira > > > > with a main task containing the main "rules" of documentation and > > several > > > > subtasks for each topic. > > > > > > > > I suggest to have also a process to move documentation from the Wiki > > to the > > > > documentation in the repository. We should make sure that we do not > > have > > > > different documentation in both places. If someone is working on a > > topic he > > > > also could search the Wiki for it and try to merge/move it where > > applicable. > > > > > > > > Moved/merged documentation from the Wiki should then be moved to an > > adoc > > > > Attic until everthing is cleared and the community agrees to remove it > > from > > > > the Wiki. > > > > > > > > We should also define which contents should be in the repository and > > what > > > > the Wiki should contain or be linked to. > > > > > > > > These are my first thoughts, happy to get some feedback and news from > > the > > > > Skype call. > > > > > > > > Thanks, > > > > > > > > Michael Brohl > > > > ecomify GmbH > > > > www.ecomify.de > > > > > > > > Am 21.02.18 um 09:21 schrieb Sharan Foga: > > > > > > > >> Hi All > > > >> > > > >> Thanks for all the feedback received about the documentation effort. > > It is > > > >> great to see so many people wanting to be involved as part of the > > team. > > > >> Based on the feedback I've seen so far I would like to confirm the > > date and > > > >> time of the Skype call next week to kick start the documentation > > effort. > > > >> > > > >> The call will be on Tuesday 27th February at 14.00 (UTC+1) > > > >> > > > >> See below for what this time is for other UTC times > > > >> > > > >> UTC-5 (New York, Boston): 08.00 > > > >> UTC+1 (Czech Republic, Germany, France, Italy) : 14.00 > > > >> UTC+2 (South Africa): 15.00 > > > >> UTC+3 (Kuwait) : 16.00 > > > >> UTC+5 (Pakistan) : 18.00 > > > >> UTC+5.5 (India) : 18.30 > > > >> > > > >> Please remember that anyone and everyone can join the team at any > > time and > > > >> you don't need to be an expert in OFBiz to contribute to it. In fact > > I think > > > >> that people new to OFBiz have a unique perspective and can let us > > know if > > > >> what has been written is easy to understand! > > > >> > > > >> If you can't make the call, then don't worry as we will be writing up > > the > > > >> notes about what was discussed and post the details to the mailing > > list. > > > >> > > > >> Thanks > > > >> Sharan > > > > > > > > > > > > > > > > > >
