I like it. It has the amazing upsert high level design document from https://cwiki.apache.org/confluence/display/ASTERIXDB/Upsert which is nice :-) I think we should start by adding things to the wiki since it is straight forward and good enough.
I think that we should require some documentation with each change and maybe even enforce linking to the wiki page in the change commit message? Cheers, Abdullah. Amoudi, Abdullah. On Tue, Dec 1, 2015 at 8:55 PM, Young-Seok Kim <[email protected]> wrote: > It seems to provide a way for collaborator to work together by invitation. > > ---------- Forwarded message ---------- > From: Young-Seok Kim <[email protected]> > Date: Tue, Dec 1, 2015 at 8:39 PM > Subject: Re: Internal documentation > To: [email protected] > > > Sorry, it's not editable. :( > > On Tue, Dec 1, 2015 at 8:38 PM, Young-Seok Kim <[email protected]> wrote: > > > I spent 45 minutes to create the following book for the demo purpose: > > > > > > > https://www.gitbook.com/book/kisskys/asterixdb-internal-development-document/details > > > > If you follow the link, you can > > > > 1. read the book online > > 2. download the book in pdf format > > 3. edit the book as well. > > > > Please have a look. > > > > Best, > > Young-Seok > > > > > > On Tue, Dec 1, 2015 at 6:00 PM, Till Westmann <[email protected]> wrote: > > > >> A few people have already started to add design docs to our wiki [1]. > >> I think that that's not a bad place for such documents. > >> However, I'm not sure what "formal internal documentation" is. > >> The documents we have there so far are no necessarily formal - but very > >> (!) helpful. > >> > >> Cheers, > >> Till > >> > >> [1] https://cwiki.apache.org/confluence/display/ASTERIXDB/Design+Docs > >> > >> > On Dec 1, 2015, at 4:29 PM, Chen Li <[email protected]> wrote: > >> > > >> > Per our recent discussions, we need to improve our protocol (if any) > >> > to do internal documentation so that knowledge can be archived and > >> > accumulated. There are many possibilities. > >> > > >> > One way I used in the past is: (1) Use wiki for formal internal > >> > documentation; (2) Use Google Docs for interactive discussions, but > >> > final results should be converted into wiki pages. (3) Each wiki page > >> > has an author and a reviewer. > >> > > >> > Other thoughts? > >> > > >> > Chen > >> > > > > >
