ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Denis Magda <dma...@apache.org>
Subject Re: New Ignite Docs: Status and Incomplete Items
Date Sat, 03 Oct 2020 03:43:36 GMT
Hi,

Thanks for finding the time and walking through the documentation pages. We
didn't intend to copy the docs as is. There are a lot of structural changes
as well as complete rewrites of pages.
Also, some of the old pages were skipped deliberately, if they were about
legacy or rarely used APIs.

Please see inline for extra thoughts. Btw, try out the search toolbox that
can point out to a new location of certain docs.

-
Denis


On Fri, Oct 2, 2020 at 8:05 PM 18624049226 <18624049226@163.com> wrote:

> Hi Denis,
>
> I have roughly compared the new document with the original document. The
> corresponding page in the list below shows that the new version of the
> document is missing or incomplete, please confirm it again.
> I didn't check every paragraph of the new document, so this is just a hint.
>
> https://ignite.apache.org/docs/latest/installation/deb-rpm

https://ignite.apache.org/docs/latest/installation/deb-rpm


>
>
> https://apacheignite.readme.io/docs/mesos-deployment
> https://apacheignite.readme.io/docs/yarn-deployment


Those are legacy installation options. We agreed not to bring them to the
new docs.

>
> https://apacheignite.readme.io/docs/generic-configuration


That generic K8 configuration was referenced from cloud-specific pages.
Now, the whole installation process is adopted for every cloud environment
so that the reader doesn't
need to jump back and forth between the generic and cloud-specific K8 pages.


>
> https://apacheignite.readme.io/docs/memory-defragmentation


https://ignite.apache.org/docs/latest/memory-architecture#memory-defragmentation


>
> https://apacheignite.readme.io/docs/distributed-locks
> https://apacheignite.readme.io/docs/messaging


These two were missed, I'll add them to the new docs.


> https://apacheignite.readme.io/docs/perfomance-benchmarking


Same, I'll add it.


> https://apacheignite-mix.readme.io/docs/amazon-aws


https://ignite.apache.org/docs/latest/clustering/discovery-in-the-cloud


>
> https://apacheignite-mix.readme.io/docs/web-session-clustering


The page is outdated. There are many blog posts and articles on the topic
on the Internet. We deliberately skipped it.


>
> https://apacheignite-mix.readme.io/docs/installation-in-apache-karaf


The module is not maintained and there are no signs that anybody uses it.
No plans to port.


>
> https://apacheignite.readme.io/docs/ignite-life-cycle


https://ignite.apache.org/docs/latest/starting-nodes#node-lifecycle-events


>
> https://apacheignite.readme.io/docs/thread-pools


https://ignite.apache.org/docs/latest/perf-and-troubleshooting/thread-pools-tuning


>
> https://apacheignite.readme.io/docs/async-support


This page seems redundant. It should be enough to open JavaDocs and see
sync and async versions of the APIs.

--
Denis


>
> 在 2020/10/3 上午4:44, Denis Magda 写道:
> > Thanks Pavel! Merged.
> >
> > Alright, guys, we've finished with the porting of all useful pages to the
> > new docs engine as well as documented all the primate Ignite 2.9
> > enhancements.
> >
> > On Monday (Oct 5ht), I'll do some final tweaks and start integrating the
> > feature branch into the master.* Refrain from doing any documentation
> > changes or sending pull-requests until further notice.*
> >
> > -
> > Denis
> >
> >
> > On Fri, Oct 2, 2020 at 7:50 AM Pavel Tupitsyn <ptupitsyn@apache.org>
> wrote:
> >
> >> Denis, IGNITE-13331 is ready for your review
> >> https://issues.apache.org/jira/browse/IGNITE-13331
> >>
> >> On Thu, Oct 1, 2020 at 9:42 AM Pavel Tupitsyn <ptupitsyn@apache.org>
> >> wrote:
> >>
> >>> Denis,
> >>>
> >>> Thanks a lot for porting those changes, great job!
> >>> I'm working on IGNITE-13331, sorry for the delay.
> >>>
> >>> On Wed, Sep 30, 2020 at 2:15 AM Denis Magda <dmagda@apache.org> wrote:
> >>>
> >>>> You might need to empty the browser cache to see the latest changes
> such
> >>>> as
> >>>> the "C# and .NET Specific" section that was published today. There is
> >> some
> >>>> CSS issue that doesn't invalidate browsing caches. It will be fixed
> >> soon.
> >>>> -
> >>>> Denis
> >>>>
> >>>>
> >>>> On Tue, Sep 29, 2020 at 4:12 PM Denis Magda <dmagda@apache.org>
> wrote:
> >>>>
> >>>>> Pavel,
> >>>>>
> >>>>> I ported all the .NET-specific pages from readme.io with minor
> >> changes.
> >>>>> The docs are under the "C# and .NET Specific" section down the
> >>>> navigation
> >>>>> tree:
> >>>>> https://ignite.apache.org/docs/latest
> >>>>>
> >>>>> The thin-client related docs are under the "Thin Clients" sections.
> It
> >>>> all
> >>>>> makes things look a bit clumsy for now (that some .NET docs are
under
> >>>> the
> >>>>> ".NET specific" section while some under "Thin Clients) but I'll
let
> >>>>> technical-writing contributors review and restructure everything
> >> later.
> >>>>> As for the IGNITE-13331, put the changes under the "Thin Clients".
> >>>>>
> >>>>>
> >>>>> -
> >>>>> Denis
> >>>>>
> >>>>>
> >>>>> On Fri, Sep 25, 2020 at 12:49 PM Denis Magda <dmagda@apache.org>
> >> wrote:
> >>>>>> Pavel,
> >>>>>>
> >>>>>> Alright, I'll do the porting of those pages and you'll take
care of
> >>>>>> IGNITE-13331 <https://issues.apache.org/jira/browse/IGNITE-13331>.
> >>>> Let's
> >>>>>> split the job.
> >>>>>>
> >>>>>> Nikolay, I'll review your contribution early next week.
> >>>>>>
> >>>>>> Thanks, folks, for the cooperation.
> >>>>>>
> >>>>>> -
> >>>>>> Denis
> >>>>>>
> >>>>>>
> >>>>>> On Thu, Sep 24, 2020 at 11:19 PM Pavel Tupitsyn <
> >> ptupitsyn@apache.org>
> >>>>>> wrote:
> >>>>>>
> >>>>>>>> Do you want me to port those pages or are you going
to do it
> >>>> yourself?
> >>>>>>> I'm ok either way, any help with this will be greatly appreciated
> :)
> >>>>>>>
> >>>>>>>> Are you saying the .NET community no longer uses those?
> >>>>>>> Existing integrations are for legacy technologies.
> >>>>>>> We are going to remove them in 3.0 [1] and, hopefully, replace
them
> >>>> with
> >>>>>>> modern equivalents later.
> >>>>>>>
> >>>>>>> [1]
> >>>>>>>
> >>>>>>>
> >>
> https://cwiki.apache.org/confluence/display/IGNITE/Apache+Ignite+3.0+Wishlist
> >>>>>>> On Fri, Sep 25, 2020 at 2:20 AM Denis Magda <dmagda@apache.org>
> >>>> wrote:
> >>>>>>>> Pavel, thanks for preparing the list of the missing
pages. Do you
> >>>> want
> >>>>>>> me
> >>>>>>>> to port those pages or are you going to do it yourself?
> >>>>>>>>
> >>>>>>>> Btw, what's wrong with the 3rd-party integrations? Are
you saying
> >>>> the
> >>>>>>> .NET
> >>>>>>>> community no longer uses those?
> >>>>>>>>
> >>>>>>>> -
> >>>>>>>> Denis
> >>>>>>>>
> >>>>>>>>
> >>>>>>>> On Fri, Sep 18, 2020 at 5:45 AM Pavel Tupitsyn <
> >>>> ptupitsyn@apache.org>
> >>>>>>>> wrote:
> >>>>>>>>
> >>>>>>>>> Denis,
> >>>>>>>>>
> >>>>>>>>>> @Pavel Tupitsyn <ptupitsyn@apache.org>
... Are you going to
> >>>>>>> document
> >>>>>>>> the
> >>>>>>>>> features added in 2.9  <
> >>>>>>>> https://issues.apache.org/jira/browse/IGNITE-13331
> >>>>>>>>> Yes, I have this on my plate, but the release was
postponed so I
> >>>>>>>> postponed
> >>>>>>>>> the task as well.
> >>>>>>>>>
> >>>>>>>>>
> >>>>>>>>>> is there is anything else you planned to move
from readme.io?
> >>>>>>>>> A list of missing things:
> >>>>>>>>> - Standalone nodes [1]
> >>>>>>>>> - Java detection, known issues [2]
> >>>>>>>>> - XML configuration [3]
> >>>>>>>>> - Serialization details [4]
> >>>>>>>>> - Platform interop [5]
> >>>>>>>>> - Deployment [6]
> >>>>>>>>> - Troubleshooting [7]
> >>>>>>>>> - Assembly loading [8]
> >>>>>>>>> - LINQ [9]
> >>>>>>>>> - Calling Java services [10]
> >>>>>>>>> - Plugins [11]
> >>>>>>>>> - Logging [12]
> >>>>>>>>>
> >>>>>>>>> Also "Third-party integrations", but I consider
them legacy, so
> >> we
> >>>>>>> can
> >>>>>>>>> skip that.
> >>>>>>>>>
> >>>>>>>>> [1] https://apacheignite-net.readme.io/docs/standalone-nodes
> >>>>>>>>> [2]
> >>>> https://apacheignite-net.readme.io/docs/cross-platform-support
> >>>>>>>>> [3] https://apacheignite-net.readme.io/docs/configuration
> >>>>>>>>> [4] https://apacheignite-net.readme.io/docs/serialization
> >>>>>>>>> [5]
> >>>>>>> https://apacheignite-net.readme.io/docs/platform-interoperability
> >>>>>>>>> [6] https://apacheignite-net.readme.io/docs/deployment
> >>>>>>>>> [7] https://apacheignite-net.readme.io/docs/troubleshooting
> >>>>>>>>> [8] https://apacheignite-net.readme.io/docs/zero-deployment
> >>>>>>>>> [9] https://apacheignite-net.readme.io/docs/sql-database
> >>>>>>>>> [10]
> >>>> https://apacheignite-net.readme.io/docs/calling-java-services
> >>>>>>>>> [11] https://apacheignite-net.readme.io/docs/plugins
> >>>>>>>>> [12] https://apacheignite-net.readme.io/docs/logging
> >>>>>>>>>
> >>>>>>>>> On Fri, Sep 18, 2020 at 11:21 AM Ivan Daschinsky
<
> >>>>>>> ivandasch@gmail.com>
> >>>>>>>>> wrote:
> >>>>>>>>>
> >>>>>>>>>> Hi! As we introduce CMake build system for Ignite
C++ for
> >> Linux
> >>>>>>> and Mac
> >>>>>>>>> OS
> >>>>>>>>>> X and this improvement is in ignite 2.9, we
should document
> >> it.
> >>>>>>> (CMake
> >>>>>>>>> for
> >>>>>>>>>> windows is not ready yet and will be in 2.10)
> >>>>>>>>>> I created ticket for it and assigned it to me.
Patch will be
> >>>>>>> available
> >>>>>>>>>> soon.
> >>>>>>>>>>
> >>>>>>>>>> [1] - https://issues.apache.org/jira/browse/IGNITE-13459
> >>>>>>>>>>
> >>>>>>>>>> пт, 18 сент. 2020 г. в 09:59, Nikolay
Izhikov <
> >>>> nizhikov@apache.org
> >>>>>>>> :
> >>>>>>>>>>> Hello, Denis.
> >>>>>>>>>>>
> >>>>>>>>>>>>        • @Nikolay Izhikov, is there
any chance you can
> >>>> document
> >>>>>>> the
> >>>>>>>>> new
> >>>>>>>>>>> management commands the next week? Use me
as a reviewer.
> >>>>>>>>>>>
> >>>>>>>>>>> Yes.
> >>>>>>>>>>>
> >>>>>>>>>>>> 18 сент. 2020 г., в 02:24, Denis
Magda <dmagda@apache.org
> >>>>>>>>> написал(а):
> >>>>>>>>>>>> Folks,
> >>>>>>>>>>>>
> >>>>>>>>>>>> While Artem is unavailable, Mauricio
and I keep pushing
> >> the
> >>>> new
> >>>>>>>> docs
> >>>>>>>>>>> project to the finish line:
> >>>>>>>>>> https://ignite.apache.org/docs/latest/preface
> >>>>>>>>>>>> Overall, we hope to copy the last bits
from the readme.io
> >>>> to
> >>>>>>> the
> >>>>>>>> new
> >>>>>>>>>>> engine, document the release and contribution
process, and
> >>>> settle
> >>>>>>>> down
> >>>>>>>>>> with
> >>>>>>>>>>> the search plug-in throughout the next week
or so. The docs
> >>>> will
> >>>>>>> be
> >>>>>>>>> ready
> >>>>>>>>>>> by the time of the 2.9 release.
> >>>>>>>>>>>> But there are some items that need the
involvement of some
> >>>> of
> >>>>>>> you:
> >>>>>>>>>>>>        • @Pavel Tupitsyn, I heard
from Artem that you are
> >>>>>>> working on
> >>>>>>>>>> some
> >>>>>>>>>>> .NET-specific tasks. Are you going to document
the features
> >>>>>>> added in
> >>>>>>>>> 2.9
> >>>>>>>>>>> and is there is anything else you planned
to move from
> >>>> readme.io
> >>>>>>> ?
> >>>>>>>>>>>>        • @Nikolay Izhikov, is there
any chance you can
> >>>> document
> >>>>>>> the
> >>>>>>>>> new
> >>>>>>>>>>> management commands the next week? Use me
as a reviewer.
> >>>>>>>>>>>> Once, all the features are documented
and old pages are
> >>>> moved
> >>>>>>> from
> >>>>>>>>>>> readme.io, I'll go ahead and merge the new
docs to the
> >> master
> >>>>>>> and
> >>>>>>>>>>> ignite-2.9 branch.
> >>>>>>>>>>>> -
> >>>>>>>>>>>> Denis
> >>>>>>>>>>>
> >>>>>>>>>> --
> >>>>>>>>>> Sincerely yours, Ivan Daschinskiy
> >>>>>>>>>>
>
>

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