ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Denis Magda <dma...@apache.org>
Subject Re: sql documentation
Date Wed, 13 Sep 2017 19:39:38 GMT
Serge,

I like the proposed format. It reminds me the one chosen by MemSQL which is crystal clear:
https://docs.memsql.com/sql-reference/v5.8/sql-reference-overview/

Not 100% sure about “Java Developer Guides” section. Let me contemplate a bit and propose
other solutions.

—
Denis

> On Sep 13, 2017, at 3:41 AM, Serge Puchnin <sergey.puchnin@gmail.com> wrote:
> 
> I have done some reorganizing for the SQL documentation. 
> Thanks a lot for the review and proof read. 
> 
> 
> 
> On Wed, 13 Sep 2017 at 01:22, Dmitriy Setrakyan <dsetrakyan@apache.org <mailto:dsetrakyan@apache.org>>
wrote:
> Thanks Sergey, I think we should add SQL Syntax section on the left. Also,
> please let us know when we can proof read it. I would like to fix some
> phrasing on the page.
> 
> On Tue, Sep 12, 2017 at 8:26 AM, Serge Puchnin <sergey.puchnin@gmail.com <mailto:sergey.puchnin@gmail.com>>
> wrote:
> 
> > I've added a page for SQL language, create index statement and Upper
> > function as an example for the new format:
> >
> > https://apacheignite-sql.readme.io/v2.1/docs/create-index <https://apacheignite-sql.readme.io/v2.1/docs/create-index>
> >
> >
> >
> > For me, it'd be OK to add a separate page for each SQL statement.
> >
> >
> > BR,
> >
> > Serge
> >
> > On Sat, 9 Sep 2017 at 02:19, Denis Magda <dmagda@apache.org <mailto:dmagda@apache.org>>
wrote:
> >
> > > Please check you inbox.
> > >
> > > —
> > > Denis
> > >
> > > > On Sep 8, 2017, at 3:38 PM, Dmitriy Setrakyan <dsetrakyan@apache.org
<mailto:dsetrakyan@apache.org>>
> > > wrote:
> > > >
> > > > Denis,
> > > >
> > > > Can you please add me as an admin to that site?
> > > >
> > > > D.
> > > >
> > > > On Fri, Sep 8, 2017 at 3:23 PM, Denis Magda <dmagda@apache.org <mailto:dmagda@apache.org>>
wrote:
> > > >
> > > >> Igniter (especially those who are willing to work on the new SQL doc),
> > > >>
> > > >> The doc for SQL capabilities has been set up. Copy pasted all the
SQL
> > > >> materials we have there:
> > > >> https://apacheignite-sql.readme.io/docs <https://apacheignite-sql.readme.io/docs>
<https://apacheignite-sql <https://apacheignite-sql/>.
> > > >> readme.io/docs <http://readme.io/docs>>
> > > >>
> > > >> Sergey P., feel free to start reworking the doc according to the new
> > > >> proposed format. Don’t hesitate removing outdating or misleading
> > > content.
> > > >> If you’re uncertain about something just send us a message here.
> > > >>
> > > >> Presently the doc is not indexed by searching engines. Let’s finish
it
> > > >> first and announce afterwards.
> > > >>
> > > >> —
> > > >> Denis
> > > >>
> > > >>> On Aug 30, 2017, at 5:43 PM, Dmitriy Setrakyan <
> > dsetrakyan@apache.org <mailto:dsetrakyan@apache.org>>
> > > >> wrote:
> > > >>>
> > > >>> On Wed, Aug 30, 2017 at 10:04 PM, Denis Magda <dmagda@apache.org
<mailto:dmagda@apache.org>>
> > > wrote:
> > > >>>
> > > >>>> Serge,
> > > >>>>
> > > >>>> Undoubtedly, I like this format. I’ve created a new documentation
> > > domain
> > > >>>> for all our SQL capabilities:
> > > >>>> https://apacheignite-sql.readme.io/docs <https://apacheignite-sql.readme.io/docs>
<https://apacheignite-sql <https://apacheignite-sql/>.
> > > >>>> readme.io/docs <http://readme.io/docs>>
> > > >>>>
> > > >>>> Once I get an open source license for it we can start moving
the
> > > >> existing
> > > >>>> docs and create the new there.
> > > >>>>
> > > >>>
> > > >>> Sounds good. We should make sure that we do not "move" the
> > > documentation,
> > > >>> we should "copy" it. Otherwise we will get 404 errors in google.
> > > >>>
> > > >>>
> > > >>>>
> > > >>>> —
> > > >>>> Denis
> > > >>>>
> > > >>>>> On Aug 30, 2017, at 4:38 AM, Serge Puchnin n <
> > > sergey.puchnin@gmail.com <mailto:sergey.puchnin@gmail.com>
> > > >>>
> > > >>>> wrote:
> > > >>>>>
> > > >>>>> Sorry for inconvenience!
> > > >>>>> there is a link for a sample:
> > > >>>>> https://drive.google.com/open?id=0B-s4Ivq- <https://drive.google.com/open?id=0B-s4Ivq->
> > > >> lrPobzZ4c2Y1X1ZLcWhGenE4TllVM3
> > > >>>> VlODhtT2Iw
> > > >>>>>
> > > >>>>> Serge
> > > >>>>>
> > > >>>>>> On 29 Aug 2017, at 19:30, Denis Magda <dmagda@apache.org
<mailto:dmagda@apache.org>> wrote:
> > > >>>>>>
> > > >>>>>> Serge,
> > > >>>>>>
> > > >>>>>> The attachment is missing. Try to share it via google
drive or
> > other
> > > >>>> storage.
> > > >>>>>>
> > > >>>>>> —
> > > >>>>>> Denis
> > > >>>>>>
> > > >>>>>>> On Aug 29, 2017, at 2:38 AM, Serge Puchnin <
> > > sergey.puchnin@gmail.com <mailto:sergey.puchnin@gmail.com>
> > > >>>
> > > >>>> wrote:
> > > >>>>>>>
> > > >>>>>>> Hi !
> > > >>>>>>>
> > > >>>>>>> As I can see, there is some room for documentation
improvement.
> > > >>>>>>> As a sample of documentation, I've prepared a
description of
> > > "CREATE
> > > >>>> INDEX" statement.
> > > >>>>>>>
> > > >>>>>>> What’s your opinion?
> > > >>>>>>> What can be improved?
> > > >>>>>>> What should be added?
> > > >>>>>>>
> > > >>>>>>> Thanks a lot!
> > > >>>>>>>
> > > >>>>>>> ---
> > > >>>>>>> Serge
> > > >>>>>>
> > > >>>>
> > > >>>>
> > > >>
> > > >>
> > >
> > >
> >


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message