You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ignite.apache.org by Stanislav Lukyanov <st...@gmail.com> on 2019/01/30 12:24:37 UTC
.Net docs need to be aligned with Java - dev review needed!
Hi Igniters,
I see that some parts of the .Net docs on readme.io are outdated compared to the Java docs.
E.g. take off-heap memory page https://apacheignite-net.readme.io/docs/off-heap-memory - the info there is for Ignite 1.x
while in 2.x we don’t have all these tiered modes.
Such discrepancies are very misleading to users, especially new ones.
I’ve filed a ticket https://issues.apache.org/jira/browse/IGNITE-10887 for Documentation.
Artem Budnikov agreed to do the updates on readme.io, but he needs the list of the documentation parts that need changing.
All Igniters and especially .Net users,
Please take a moment to go over the .Net docs at https://apacheignite-net.readme.io/docs/,
page by page, and if you see anything that is obviously wrong/false/misleading, please add that as a comment to the
https://issues.apache.org/jira/browse/IGNITE-10887.
If you review any part of the docs, please let us know here so that we know which parts are covered.
I would suggest we focus on false/outdated information only.
If some part of the docs is not clear enough that’s a different issue. Here I’d like to only collect the list of the sections with things that are
not applicable to Ignite 2.7.
Thanks,
Stan
Re: .Net docs need to be aligned with Java - dev review needed!
Posted by Dmitriy Pavlov <dp...@apache.org>.
Welcome, Garret!
BTW, Please note that usage of personal email addresses in Apache space is
encouraged.
вт, 2 апр. 2019 г. в 18:18, Denis Magda <dm...@apache.org>:
> Folks,
>
> Thanks for putting this together. Let me introduce Garret to our community.
> Garret is a professional technical writer and leader who was in charge of
> many excellent documentation products.
>
> Garret, would you mind helping us and groom Ignite .Net docs?
>
> -
> Denis
>
>
> On Tue, Apr 2, 2019 at 7:56 AM Ilya Kasnacheev <il...@gmail.com>
> wrote:
>
> > Hello!
> >
> > So I went through this section as well:
> > https://apacheignite-net.readme.io/docs/ignite-facts diverged from
> > https://apacheignite.readme.io/docs/ignite-facts
> > https://apacheignite-net.readme.io/docs/getting-started-2 Java 11
> > recommendations?
> > https://apacheignite-net.readme.io/docs/performance-tips Cache StartSize
> > is
> > very deprecated. Do we even have (non-page) Eviction? "Tune GC" section
> > sounds outdated, recommend G1?
> > https://apacheignite-net.readme.io/docs/serialization Let's remove all
> > "Ignite 2.0" blocks or convert it to plain text since it's what we have.
> > BinaryReflectiveSerializer - do we even have it configurable?
> > https://apacheignite-net.readme.io/docs/leader-election diverged from
> > https://apacheignite.readme.io/docs/leader-election
> > https://apacheignite-net.readme.io/docs/cluster called clustering and
> > refers to other sections in
> https://apacheignite.readme.io/docs/clustering
> > Persistence and Data Grid sections need to be checked for sync.
> > https://apacheignite-net.readme.io/docs/eviction-policies talks about
> > evicting from on-heap, needs to be actualized.
> > https://apacheignite-net.readme.io/docs/off-heap-memory No longer have
> > tiered, let's boot swap space too.
> > https://apacheignite-net.readme.io/docs/service-grid out of sync with
> > https://apacheignite.readme.io/docs/service-grid
> >
> > Next question is what to do with this information?
> > I guess we should do C++ as well.
> >
> > Regards,
> > --
> > Ilya Kasnacheev
> >
> >
> > чт, 31 янв. 2019 г. в 14:38, Вячеслав Коптилин <slava.koptilin@gmail.com
> >:
> >
> > > Hello Igniters,
> > >
> > > It seems that https://apacheignite-net.readme.io/docs/performance-tips
> > is
> > > outdated as well.
> > > In particular,
> > >
> > >
> >
> https://apacheignite-net.readme.io/docs/performance-tips#section-tune-cache-start-size
> > > does not make sense as of Apache Ignite 2.x.
> > > I added a comment to the mentioned jira ticket.
> > >
> > > Thanks,
> > > S.
> > >
> > > чт, 31 янв. 2019 г. в 08:22, Denis Magda <dm...@apache.org>:
> > >
> > > > Thanks, Stan for catching that.
> > > >
> > > > Expiration and eviction policies are not aligned with Java
> counterparts
> > > as
> > > > well:
> > > > https://apacheignite-net.readme.io/docs/eviction-policies
> > > > https://apacheignite-net.readme.io/docs/expiry-policies
> > > >
> > > > In Java we explain how it works for the new off-heap memory and
> on-heap
> > > > Java cache, while .Net docs are based on no longer supported Ignite
> 1.x
> > > > memory architecture.
> > > >
> > > >
> > > > -
> > > > Denis
> > > >
> > > >
> > > > On Wed, Jan 30, 2019 at 4:34 AM Stanislav Lukyanov <
> > > stanlukyanov@gmail.com
> > > > >
> > > > wrote:
> > > >
> > > > > Hi Igniters,
> > > > >
> > > > > I see that some parts of the .Net docs on readme.io are outdated
> > > > compared
> > > > > to the Java docs.
> > > > > E.g. take off-heap memory page
> > > > > https://apacheignite-net.readme.io/docs/off-heap-memory - the info
> > > there
> > > > > is for Ignite 1.x
> > > > > while in 2.x we don’t have all these tiered modes.
> > > > > Such discrepancies are very misleading to users, especially new
> ones.
> > > > >
> > > > > I’ve filed a ticket
> > https://issues.apache.org/jira/browse/IGNITE-10887
> > > > > for Documentation.
> > > > > Artem Budnikov agreed to do the updates on readme.io, but he needs
> > the
> > > > > list of the documentation parts that need changing.
> > > > >
> > > > > All Igniters and especially .Net users,
> > > > > Please take a moment to go over the .Net docs at
> > > > > https://apacheignite-net.readme.io/docs/,
> > > > > page by page, and if you see anything that is obviously
> > > > > wrong/false/misleading, please add that as a comment to the
> > > > > https://issues.apache.org/jira/browse/IGNITE-10887.
> > > > > If you review any part of the docs, please let us know here so that
> > we
> > > > > know which parts are covered.
> > > > >
> > > > > I would suggest we focus on false/outdated information only.
> > > > > If some part of the docs is not clear enough that’s a different
> > issue.
> > > > > Here I’d like to only collect the list of the sections with things
> > that
> > > > are
> > > > > not applicable to Ignite 2.7.
> > > > >
> > > > > Thanks,
> > > > > Stan
> > > > >
> > > >
> > >
> >
>
Re: .Net docs need to be aligned with Java - dev review needed!
Posted by Denis Magda <dm...@apache.org>.
Folks,
Thanks for putting this together. Let me introduce Garret to our community.
Garret is a professional technical writer and leader who was in charge of
many excellent documentation products.
Garret, would you mind helping us and groom Ignite .Net docs?
-
Denis
On Tue, Apr 2, 2019 at 7:56 AM Ilya Kasnacheev <il...@gmail.com>
wrote:
> Hello!
>
> So I went through this section as well:
> https://apacheignite-net.readme.io/docs/ignite-facts diverged from
> https://apacheignite.readme.io/docs/ignite-facts
> https://apacheignite-net.readme.io/docs/getting-started-2 Java 11
> recommendations?
> https://apacheignite-net.readme.io/docs/performance-tips Cache StartSize
> is
> very deprecated. Do we even have (non-page) Eviction? "Tune GC" section
> sounds outdated, recommend G1?
> https://apacheignite-net.readme.io/docs/serialization Let's remove all
> "Ignite 2.0" blocks or convert it to plain text since it's what we have.
> BinaryReflectiveSerializer - do we even have it configurable?
> https://apacheignite-net.readme.io/docs/leader-election diverged from
> https://apacheignite.readme.io/docs/leader-election
> https://apacheignite-net.readme.io/docs/cluster called clustering and
> refers to other sections in https://apacheignite.readme.io/docs/clustering
> Persistence and Data Grid sections need to be checked for sync.
> https://apacheignite-net.readme.io/docs/eviction-policies talks about
> evicting from on-heap, needs to be actualized.
> https://apacheignite-net.readme.io/docs/off-heap-memory No longer have
> tiered, let's boot swap space too.
> https://apacheignite-net.readme.io/docs/service-grid out of sync with
> https://apacheignite.readme.io/docs/service-grid
>
> Next question is what to do with this information?
> I guess we should do C++ as well.
>
> Regards,
> --
> Ilya Kasnacheev
>
>
> чт, 31 янв. 2019 г. в 14:38, Вячеслав Коптилин <sl...@gmail.com>:
>
> > Hello Igniters,
> >
> > It seems that https://apacheignite-net.readme.io/docs/performance-tips
> is
> > outdated as well.
> > In particular,
> >
> >
> https://apacheignite-net.readme.io/docs/performance-tips#section-tune-cache-start-size
> > does not make sense as of Apache Ignite 2.x.
> > I added a comment to the mentioned jira ticket.
> >
> > Thanks,
> > S.
> >
> > чт, 31 янв. 2019 г. в 08:22, Denis Magda <dm...@apache.org>:
> >
> > > Thanks, Stan for catching that.
> > >
> > > Expiration and eviction policies are not aligned with Java counterparts
> > as
> > > well:
> > > https://apacheignite-net.readme.io/docs/eviction-policies
> > > https://apacheignite-net.readme.io/docs/expiry-policies
> > >
> > > In Java we explain how it works for the new off-heap memory and on-heap
> > > Java cache, while .Net docs are based on no longer supported Ignite 1.x
> > > memory architecture.
> > >
> > >
> > > -
> > > Denis
> > >
> > >
> > > On Wed, Jan 30, 2019 at 4:34 AM Stanislav Lukyanov <
> > stanlukyanov@gmail.com
> > > >
> > > wrote:
> > >
> > > > Hi Igniters,
> > > >
> > > > I see that some parts of the .Net docs on readme.io are outdated
> > > compared
> > > > to the Java docs.
> > > > E.g. take off-heap memory page
> > > > https://apacheignite-net.readme.io/docs/off-heap-memory - the info
> > there
> > > > is for Ignite 1.x
> > > > while in 2.x we don’t have all these tiered modes.
> > > > Such discrepancies are very misleading to users, especially new ones.
> > > >
> > > > I’ve filed a ticket
> https://issues.apache.org/jira/browse/IGNITE-10887
> > > > for Documentation.
> > > > Artem Budnikov agreed to do the updates on readme.io, but he needs
> the
> > > > list of the documentation parts that need changing.
> > > >
> > > > All Igniters and especially .Net users,
> > > > Please take a moment to go over the .Net docs at
> > > > https://apacheignite-net.readme.io/docs/,
> > > > page by page, and if you see anything that is obviously
> > > > wrong/false/misleading, please add that as a comment to the
> > > > https://issues.apache.org/jira/browse/IGNITE-10887.
> > > > If you review any part of the docs, please let us know here so that
> we
> > > > know which parts are covered.
> > > >
> > > > I would suggest we focus on false/outdated information only.
> > > > If some part of the docs is not clear enough that’s a different
> issue.
> > > > Here I’d like to only collect the list of the sections with things
> that
> > > are
> > > > not applicable to Ignite 2.7.
> > > >
> > > > Thanks,
> > > > Stan
> > > >
> > >
> >
>
Re: .Net docs need to be aligned with Java - dev review needed!
Posted by Ilya Kasnacheev <il...@gmail.com>.
Hello!
So I went through this section as well:
https://apacheignite-net.readme.io/docs/ignite-facts diverged from
https://apacheignite.readme.io/docs/ignite-facts
https://apacheignite-net.readme.io/docs/getting-started-2 Java 11
recommendations?
https://apacheignite-net.readme.io/docs/performance-tips Cache StartSize is
very deprecated. Do we even have (non-page) Eviction? "Tune GC" section
sounds outdated, recommend G1?
https://apacheignite-net.readme.io/docs/serialization Let's remove all
"Ignite 2.0" blocks or convert it to plain text since it's what we have.
BinaryReflectiveSerializer - do we even have it configurable?
https://apacheignite-net.readme.io/docs/leader-election diverged from
https://apacheignite.readme.io/docs/leader-election
https://apacheignite-net.readme.io/docs/cluster called clustering and
refers to other sections in https://apacheignite.readme.io/docs/clustering
Persistence and Data Grid sections need to be checked for sync.
https://apacheignite-net.readme.io/docs/eviction-policies talks about
evicting from on-heap, needs to be actualized.
https://apacheignite-net.readme.io/docs/off-heap-memory No longer have
tiered, let's boot swap space too.
https://apacheignite-net.readme.io/docs/service-grid out of sync with
https://apacheignite.readme.io/docs/service-grid
Next question is what to do with this information?
I guess we should do C++ as well.
Regards,
--
Ilya Kasnacheev
чт, 31 янв. 2019 г. в 14:38, Вячеслав Коптилин <sl...@gmail.com>:
> Hello Igniters,
>
> It seems that https://apacheignite-net.readme.io/docs/performance-tips is
> outdated as well.
> In particular,
>
> https://apacheignite-net.readme.io/docs/performance-tips#section-tune-cache-start-size
> does not make sense as of Apache Ignite 2.x.
> I added a comment to the mentioned jira ticket.
>
> Thanks,
> S.
>
> чт, 31 янв. 2019 г. в 08:22, Denis Magda <dm...@apache.org>:
>
> > Thanks, Stan for catching that.
> >
> > Expiration and eviction policies are not aligned with Java counterparts
> as
> > well:
> > https://apacheignite-net.readme.io/docs/eviction-policies
> > https://apacheignite-net.readme.io/docs/expiry-policies
> >
> > In Java we explain how it works for the new off-heap memory and on-heap
> > Java cache, while .Net docs are based on no longer supported Ignite 1.x
> > memory architecture.
> >
> >
> > -
> > Denis
> >
> >
> > On Wed, Jan 30, 2019 at 4:34 AM Stanislav Lukyanov <
> stanlukyanov@gmail.com
> > >
> > wrote:
> >
> > > Hi Igniters,
> > >
> > > I see that some parts of the .Net docs on readme.io are outdated
> > compared
> > > to the Java docs.
> > > E.g. take off-heap memory page
> > > https://apacheignite-net.readme.io/docs/off-heap-memory - the info
> there
> > > is for Ignite 1.x
> > > while in 2.x we don’t have all these tiered modes.
> > > Such discrepancies are very misleading to users, especially new ones.
> > >
> > > I’ve filed a ticket https://issues.apache.org/jira/browse/IGNITE-10887
> > > for Documentation.
> > > Artem Budnikov agreed to do the updates on readme.io, but he needs the
> > > list of the documentation parts that need changing.
> > >
> > > All Igniters and especially .Net users,
> > > Please take a moment to go over the .Net docs at
> > > https://apacheignite-net.readme.io/docs/,
> > > page by page, and if you see anything that is obviously
> > > wrong/false/misleading, please add that as a comment to the
> > > https://issues.apache.org/jira/browse/IGNITE-10887.
> > > If you review any part of the docs, please let us know here so that we
> > > know which parts are covered.
> > >
> > > I would suggest we focus on false/outdated information only.
> > > If some part of the docs is not clear enough that’s a different issue.
> > > Here I’d like to only collect the list of the sections with things that
> > are
> > > not applicable to Ignite 2.7.
> > >
> > > Thanks,
> > > Stan
> > >
> >
>
Re: .Net docs need to be aligned with Java - dev review needed!
Posted by Вячеслав Коптилин <sl...@gmail.com>.
Hello Igniters,
It seems that https://apacheignite-net.readme.io/docs/performance-tips is
outdated as well.
In particular,
https://apacheignite-net.readme.io/docs/performance-tips#section-tune-cache-start-size
does not make sense as of Apache Ignite 2.x.
I added a comment to the mentioned jira ticket.
Thanks,
S.
чт, 31 янв. 2019 г. в 08:22, Denis Magda <dm...@apache.org>:
> Thanks, Stan for catching that.
>
> Expiration and eviction policies are not aligned with Java counterparts as
> well:
> https://apacheignite-net.readme.io/docs/eviction-policies
> https://apacheignite-net.readme.io/docs/expiry-policies
>
> In Java we explain how it works for the new off-heap memory and on-heap
> Java cache, while .Net docs are based on no longer supported Ignite 1.x
> memory architecture.
>
>
> -
> Denis
>
>
> On Wed, Jan 30, 2019 at 4:34 AM Stanislav Lukyanov <stanlukyanov@gmail.com
> >
> wrote:
>
> > Hi Igniters,
> >
> > I see that some parts of the .Net docs on readme.io are outdated
> compared
> > to the Java docs.
> > E.g. take off-heap memory page
> > https://apacheignite-net.readme.io/docs/off-heap-memory - the info there
> > is for Ignite 1.x
> > while in 2.x we don’t have all these tiered modes.
> > Such discrepancies are very misleading to users, especially new ones.
> >
> > I’ve filed a ticket https://issues.apache.org/jira/browse/IGNITE-10887
> > for Documentation.
> > Artem Budnikov agreed to do the updates on readme.io, but he needs the
> > list of the documentation parts that need changing.
> >
> > All Igniters and especially .Net users,
> > Please take a moment to go over the .Net docs at
> > https://apacheignite-net.readme.io/docs/,
> > page by page, and if you see anything that is obviously
> > wrong/false/misleading, please add that as a comment to the
> > https://issues.apache.org/jira/browse/IGNITE-10887.
> > If you review any part of the docs, please let us know here so that we
> > know which parts are covered.
> >
> > I would suggest we focus on false/outdated information only.
> > If some part of the docs is not clear enough that’s a different issue.
> > Here I’d like to only collect the list of the sections with things that
> are
> > not applicable to Ignite 2.7.
> >
> > Thanks,
> > Stan
> >
>
Re: .Net docs need to be aligned with Java - dev review needed!
Posted by Denis Magda <dm...@apache.org>.
Thanks, Stan for catching that.
Expiration and eviction policies are not aligned with Java counterparts as
well:
https://apacheignite-net.readme.io/docs/eviction-policies
https://apacheignite-net.readme.io/docs/expiry-policies
In Java we explain how it works for the new off-heap memory and on-heap
Java cache, while .Net docs are based on no longer supported Ignite 1.x
memory architecture.
-
Denis
On Wed, Jan 30, 2019 at 4:34 AM Stanislav Lukyanov <st...@gmail.com>
wrote:
> Hi Igniters,
>
> I see that some parts of the .Net docs on readme.io are outdated compared
> to the Java docs.
> E.g. take off-heap memory page
> https://apacheignite-net.readme.io/docs/off-heap-memory - the info there
> is for Ignite 1.x
> while in 2.x we don’t have all these tiered modes.
> Such discrepancies are very misleading to users, especially new ones.
>
> I’ve filed a ticket https://issues.apache.org/jira/browse/IGNITE-10887
> for Documentation.
> Artem Budnikov agreed to do the updates on readme.io, but he needs the
> list of the documentation parts that need changing.
>
> All Igniters and especially .Net users,
> Please take a moment to go over the .Net docs at
> https://apacheignite-net.readme.io/docs/,
> page by page, and if you see anything that is obviously
> wrong/false/misleading, please add that as a comment to the
> https://issues.apache.org/jira/browse/IGNITE-10887.
> If you review any part of the docs, please let us know here so that we
> know which parts are covered.
>
> I would suggest we focus on false/outdated information only.
> If some part of the docs is not clear enough that’s a different issue.
> Here I’d like to only collect the list of the sections with things that are
> not applicable to Ignite 2.7.
>
> Thanks,
> Stan
>