Mailing-List: contact dev-help@asterixdb.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@asterixdb.incubator.apache.org
MIME-Version: 1.0
In-Reply-To: <827B4E68-FC49-4391-A762-9A86DF0D741E@apache.org>
References: 
 <CANQf6Dp7tjhY3SVheMLSrP+LvVgPLNWXYZNdZRor1Q+H-YkgMA@mail.gmail.com>
	<827B4E68-FC49-4391-A762-9A86DF0D741E@apache.org>
Date: Tue, 1 Dec 2015 20:38:17 -0800
Message-ID: 
 <CAF+3TUputRc45To2gNLwpp9i7y7vmTKNdKL-XXMsYa2_OYC=gg@mail.gmail.com>
Subject: Re: Internal documentation
From: Young-Seok Kim <kisskys@gmail.com>
To: dev@asterixdb.incubator.apache.org
Content-Type: multipart/alternative; boundary=001a11401b2ed999410525e2d780

--001a11401b2ed999410525e2d780
Content-Type: text/plain; charset=UTF-8

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 <tillw@apache.org> 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 <chenli@gmail.com> 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
>

--001a11401b2ed999410525e2d780--