Added missing pages to Ignite documentation

classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

Added missing pages to Ignite documentation

Anton Vinogradov
Hello,

I've created new pages on redme.io.
These pages describe usage of Ignite expiry policies and topology validator.
Urls:
https://apacheignite.readme.io/docs/expiry-policies
https://apacheignite.readme.io/docs/topology-validation
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

dsetrakyan
Thanks Anton!

By the way, I just noticed that the TopologyValidator has no javadoc.
Perhaps it makes sense to add it as well?

D.

On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <[hidden email]>
wrote:

> Hello,
>
> I've created new pages on redme.io.
> These pages describe usage of Ignite expiry policies and topology
> validator.
> Urls:
> https://apacheignite.readme.io/docs/expiry-policies
> https://apacheignite.readme.io/docs/topology-validation
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

Anton Vinogradov
Dmitriy,
TopologyValidator's javadoc was improved as a part of these changes.

On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <[hidden email]>
wrote:

> Thanks Anton!
>
> By the way, I just noticed that the TopologyValidator has no javadoc.
> Perhaps it makes sense to add it as well?
>
> D.
>
> On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> [hidden email]>
> wrote:
>
> > Hello,
> >
> > I've created new pages on redme.io.
> > These pages describe usage of Ignite expiry policies and topology
> > validator.
> > Urls:
> > https://apacheignite.readme.io/docs/expiry-policies
> > https://apacheignite.readme.io/docs/topology-validation
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

dsetrakyan
On Thu, Sep 10, 2015 at 12:35 AM, Anton Vinogradov <[hidden email]
> wrote:

> Dmitriy,
> TopologyValidator's javadoc was improved as a part of these changes.
>

I just checked in master, and this is the only javadoc I can find for
TopologyValidator class:

/**
 * Topology validator.
 */

A bit too pithy for my taste :)


> On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <[hidden email]>
> wrote:
>
> > Thanks Anton!
> >
> > By the way, I just noticed that the TopologyValidator has no javadoc.
> > Perhaps it makes sense to add it as well?
> >
> > D.
> >
> > On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> > [hidden email]>
> > wrote:
> >
> > > Hello,
> > >
> > > I've created new pages on redme.io.
> > > These pages describe usage of Ignite expiry policies and topology
> > > validator.
> > > Urls:
> > > https://apacheignite.readme.io/docs/expiry-policies
> > > https://apacheignite.readme.io/docs/topology-validation
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

Anton Vinogradov
Usage explaned at place where TopologyValidator used - at
CacheConfiguration.setTopologyValidator(tv).
Is it necessary to dublicate usage javadoc to TopologyValidator class?

On Thu, Sep 10, 2015 at 11:00 AM, Dmitriy Setrakyan <[hidden email]>
wrote:

> On Thu, Sep 10, 2015 at 12:35 AM, Anton Vinogradov <
> [hidden email]
> > wrote:
>
> > Dmitriy,
> > TopologyValidator's javadoc was improved as a part of these changes.
> >
>
> I just checked in master, and this is the only javadoc I can find for
> TopologyValidator class:
>
> /**
>  * Topology validator.
>  */
>
> A bit too pithy for my taste :)
>
>
> > On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <
> [hidden email]>
> > wrote:
> >
> > > Thanks Anton!
> > >
> > > By the way, I just noticed that the TopologyValidator has no javadoc.
> > > Perhaps it makes sense to add it as well?
> > >
> > > D.
> > >
> > > On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> > > [hidden email]>
> > > wrote:
> > >
> > > > Hello,
> > > >
> > > > I've created new pages on redme.io.
> > > > These pages describe usage of Ignite expiry policies and topology
> > > > validator.
> > > > Urls:
> > > > https://apacheignite.readme.io/docs/expiry-policies
> > > > https://apacheignite.readme.io/docs/topology-validation
> > > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

yzhdanov
I think that main docs should be in TopologyValidator interface. Other
places should be briefly documented and contain a link to validator
interface.

Thanks!

Yakov
On Sep 10, 2015 11:22, "Anton Vinogradov" <[hidden email]> wrote:

> Usage explaned at place where TopologyValidator used - at
> CacheConfiguration.setTopologyValidator(tv).
> Is it necessary to dublicate usage javadoc to TopologyValidator class?
>
> On Thu, Sep 10, 2015 at 11:00 AM, Dmitriy Setrakyan <[hidden email]
> >
> wrote:
>
> > On Thu, Sep 10, 2015 at 12:35 AM, Anton Vinogradov <
> > [hidden email]
> > > wrote:
> >
> > > Dmitriy,
> > > TopologyValidator's javadoc was improved as a part of these changes.
> > >
> >
> > I just checked in master, and this is the only javadoc I can find for
> > TopologyValidator class:
> >
> > /**
> >  * Topology validator.
> >  */
> >
> > A bit too pithy for my taste :)
> >
> >
> > > On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <
> > [hidden email]>
> > > wrote:
> > >
> > > > Thanks Anton!
> > > >
> > > > By the way, I just noticed that the TopologyValidator has no javadoc.
> > > > Perhaps it makes sense to add it as well?
> > > >
> > > > D.
> > > >
> > > > On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> > > > [hidden email]>
> > > > wrote:
> > > >
> > > > > Hello,
> > > > >
> > > > > I've created new pages on redme.io.
> > > > > These pages describe usage of Ignite expiry policies and topology
> > > > > validator.
> > > > > Urls:
> > > > > https://apacheignite.readme.io/docs/expiry-policies
> > > > > https://apacheignite.readme.io/docs/topology-validation
> > > > >
> > > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

Anton Vinogradov
Done, thanks for tips

On Thu, Sep 10, 2015 at 12:44 PM, Yakov Zhdanov <[hidden email]> wrote:

> I think that main docs should be in TopologyValidator interface. Other
> places should be briefly documented and contain a link to validator
> interface.
>
> Thanks!
>
> Yakov
> On Sep 10, 2015 11:22, "Anton Vinogradov" <[hidden email]>
> wrote:
>
> > Usage explaned at place where TopologyValidator used - at
> > CacheConfiguration.setTopologyValidator(tv).
> > Is it necessary to dublicate usage javadoc to TopologyValidator class?
> >
> > On Thu, Sep 10, 2015 at 11:00 AM, Dmitriy Setrakyan <
> [hidden email]
> > >
> > wrote:
> >
> > > On Thu, Sep 10, 2015 at 12:35 AM, Anton Vinogradov <
> > > [hidden email]
> > > > wrote:
> > >
> > > > Dmitriy,
> > > > TopologyValidator's javadoc was improved as a part of these changes.
> > > >
> > >
> > > I just checked in master, and this is the only javadoc I can find for
> > > TopologyValidator class:
> > >
> > > /**
> > >  * Topology validator.
> > >  */
> > >
> > > A bit too pithy for my taste :)
> > >
> > >
> > > > On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <
> > > [hidden email]>
> > > > wrote:
> > > >
> > > > > Thanks Anton!
> > > > >
> > > > > By the way, I just noticed that the TopologyValidator has no
> javadoc.
> > > > > Perhaps it makes sense to add it as well?
> > > > >
> > > > > D.
> > > > >
> > > > > On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> > > > > [hidden email]>
> > > > > wrote:
> > > > >
> > > > > > Hello,
> > > > > >
> > > > > > I've created new pages on redme.io.
> > > > > > These pages describe usage of Ignite expiry policies and topology
> > > > > > validator.
> > > > > > Urls:
> > > > > > https://apacheignite.readme.io/docs/expiry-policies
> > > > > > https://apacheignite.readme.io/docs/topology-validation
> > > > > >
> > > > >
> > > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

dsetrakyan
Thanks Anton,

I made a few edits. Please take a look and see if you agree.

D.

On Thu, Sep 10, 2015 at 3:08 AM, Anton Vinogradov <[hidden email]>
wrote:

> Done, thanks for tips
>
> On Thu, Sep 10, 2015 at 12:44 PM, Yakov Zhdanov <[hidden email]>
> wrote:
>
> > I think that main docs should be in TopologyValidator interface. Other
> > places should be briefly documented and contain a link to validator
> > interface.
> >
> > Thanks!
> >
> > Yakov
> > On Sep 10, 2015 11:22, "Anton Vinogradov" <[hidden email]>
> > wrote:
> >
> > > Usage explaned at place where TopologyValidator used - at
> > > CacheConfiguration.setTopologyValidator(tv).
> > > Is it necessary to dublicate usage javadoc to TopologyValidator class?
> > >
> > > On Thu, Sep 10, 2015 at 11:00 AM, Dmitriy Setrakyan <
> > [hidden email]
> > > >
> > > wrote:
> > >
> > > > On Thu, Sep 10, 2015 at 12:35 AM, Anton Vinogradov <
> > > > [hidden email]
> > > > > wrote:
> > > >
> > > > > Dmitriy,
> > > > > TopologyValidator's javadoc was improved as a part of these
> changes.
> > > > >
> > > >
> > > > I just checked in master, and this is the only javadoc I can find for
> > > > TopologyValidator class:
> > > >
> > > > /**
> > > >  * Topology validator.
> > > >  */
> > > >
> > > > A bit too pithy for my taste :)
> > > >
> > > >
> > > > > On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <
> > > > [hidden email]>
> > > > > wrote:
> > > > >
> > > > > > Thanks Anton!
> > > > > >
> > > > > > By the way, I just noticed that the TopologyValidator has no
> > javadoc.
> > > > > > Perhaps it makes sense to add it as well?
> > > > > >
> > > > > > D.
> > > > > >
> > > > > > On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> > > > > > [hidden email]>
> > > > > > wrote:
> > > > > >
> > > > > > > Hello,
> > > > > > >
> > > > > > > I've created new pages on redme.io.
> > > > > > > These pages describe usage of Ignite expiry policies and
> topology
> > > > > > > validator.
> > > > > > > Urls:
> > > > > > > https://apacheignite.readme.io/docs/expiry-policies
> > > > > > > https://apacheignite.readme.io/docs/topology-validation
> > > > > > >
> > > > > >
> > > > >
> > > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Added missing pages to Ignite documentation

Anton Vinogradov
Dmitriy,

Thanks for improving javadoc.
I've updated https://apacheignite.readme.io/docs/topology-validation according
to your changes.

On Fri, Sep 11, 2015 at 2:38 AM, Dmitriy Setrakyan <[hidden email]>
wrote:

> Thanks Anton,
>
> I made a few edits. Please take a look and see if you agree.
>
> D.
>
> On Thu, Sep 10, 2015 at 3:08 AM, Anton Vinogradov <
> [hidden email]>
> wrote:
>
> > Done, thanks for tips
> >
> > On Thu, Sep 10, 2015 at 12:44 PM, Yakov Zhdanov <[hidden email]>
> > wrote:
> >
> > > I think that main docs should be in TopologyValidator interface. Other
> > > places should be briefly documented and contain a link to validator
> > > interface.
> > >
> > > Thanks!
> > >
> > > Yakov
> > > On Sep 10, 2015 11:22, "Anton Vinogradov" <[hidden email]>
> > > wrote:
> > >
> > > > Usage explaned at place where TopologyValidator used - at
> > > > CacheConfiguration.setTopologyValidator(tv).
> > > > Is it necessary to dublicate usage javadoc to TopologyValidator
> class?
> > > >
> > > > On Thu, Sep 10, 2015 at 11:00 AM, Dmitriy Setrakyan <
> > > [hidden email]
> > > > >
> > > > wrote:
> > > >
> > > > > On Thu, Sep 10, 2015 at 12:35 AM, Anton Vinogradov <
> > > > > [hidden email]
> > > > > > wrote:
> > > > >
> > > > > > Dmitriy,
> > > > > > TopologyValidator's javadoc was improved as a part of these
> > changes.
> > > > > >
> > > > >
> > > > > I just checked in master, and this is the only javadoc I can find
> for
> > > > > TopologyValidator class:
> > > > >
> > > > > /**
> > > > >  * Topology validator.
> > > > >  */
> > > > >
> > > > > A bit too pithy for my taste :)
> > > > >
> > > > >
> > > > > > On Thu, Sep 10, 2015 at 6:41 AM, Dmitriy Setrakyan <
> > > > > [hidden email]>
> > > > > > wrote:
> > > > > >
> > > > > > > Thanks Anton!
> > > > > > >
> > > > > > > By the way, I just noticed that the TopologyValidator has no
> > > javadoc.
> > > > > > > Perhaps it makes sense to add it as well?
> > > > > > >
> > > > > > > D.
> > > > > > >
> > > > > > > On Sat, Sep 5, 2015 at 11:15 PM, Anton Vinogradov <
> > > > > > > [hidden email]>
> > > > > > > wrote:
> > > > > > >
> > > > > > > > Hello,
> > > > > > > >
> > > > > > > > I've created new pages on redme.io.
> > > > > > > > These pages describe usage of Ignite expiry policies and
> > topology
> > > > > > > > validator.
> > > > > > > > Urls:
> > > > > > > > https://apacheignite.readme.io/docs/expiry-policies
> > > > > > > > https://apacheignite.readme.io/docs/topology-validation
> > > > > > > >
> > > > > > >
> > > > > >
> > > > >
> > > >
> > >
> >
>