ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dmitriy Setrakyan <dsetrak...@gridgain.com>
Subject Re: Organizing documentation for platforms
Date Tue, 15 Sep 2015 09:31:25 GMT
Let me create one. I will respond here when I am done.

D.

On Tue, Sep 15, 2015 at 1:12 AM, Vladimir Ozerov <vozerov@gridgain.com>
wrote:

> Igniters,
>
> Does anyone know how what is the procedure of creating a new space in
> readme.io?
>
> On Mon, Sep 14, 2015 at 9:07 PM, Dmitriy Setrakyan <dsetrakyan@apache.org>
> wrote:
>
> > We should also take into account whether Java users will be interested in
> > .NET/C++ and vise versa. In my opinion, the users for .NET/C++ don't
> > intersect with Java users, that's why I suggested a separate
> documentation
> > space for them.
> >
> > On Mon, Sep 14, 2015 at 10:39 AM, Yakov Zhdanov <yzhdanov@apache.org>
> > wrote:
> >
> > > I like 2nd most of all.
> > >
> > > 1. Current docs have lots of general info and concepts explanation.
> > > 2. If platform doesn't support anything, you put it right on feature
> > page.
> > >
> > > Thanks!
> > >
> > > Yakov
> > > On Sep 14, 2015 12:51, "Vladimir Ozerov" <vozerov@gridgain.com> wrote:
> > >
> > > > Igniters,
> > > >
> > > > We need to add documentation for .Net and CPP platforms. There are
> > > several
> > > > approaches:
> > > >
> > > > 1) Just add corresponding .Net/CPP code snippets to existing docs.
> > > > Very easy to implement, but platform users will have to constantly
> > switch
> > > > from Java code snippets and will not understand which features exist
> in
> > > the
> > > > platform and which are not.
> > > >
> > > > 2) Place platform docs in a separate paragraph. E.g.
> > > > root
> > > > |-- Clustering
> > > > |-- ...
> > > > |-- .Net
> > > > |   |-- Clustering
> > > > |-- CPP
> > > > |   |-- Clustering
> > > >
> > > > Not very good idea, we want to position .Net and CPP as a
> fully-fledged
> > > > products, not as some secondary extension to Java version.
> > > >
> > > > 3) Create separate *readme.io <http://readme.io>* space, e.g.
> > > > *https://apacheignite-dotnet.readme.io/
> > > > <https://apacheignite-dotnet.readme.io/>* and put all relevant docs
> > > here.
> > > > The most user-friendly solution, but require more work and lead to
> docs
> > > > duplication what will make maintenance harder.
> > > >
> > > > I tend to prefer the last approach. Any ideas/thoughts?
> > > >
> > > > Vladimir.
> > > >
> > >
> >
>

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