From dev-return-53444-apmail-ignite-dev-archive=ignite.apache.org@ignite.apache.org Sat Oct 3 05:59:31 2020 Return-Path: X-Original-To: apmail-ignite-dev-archive@locus.apache.org Delivered-To: apmail-ignite-dev-archive@locus.apache.org Received: from mailroute1-lw-us.apache.org (mailroute1-lw-us.apache.org [207.244.88.153]) by minotaur.apache.org (Postfix) with ESMTP id B7AF61A5FF for ; Sat, 3 Oct 2020 05:59:30 +0000 (UTC) Received: from mail.apache.org (localhost [127.0.0.1]) by mailroute1-lw-us.apache.org (ASF Mail Server at mailroute1-lw-us.apache.org) with SMTP id 12A1D123D73 for ; Sat, 3 Oct 2020 05:59:29 +0000 (UTC) Received: (qmail 83517 invoked by uid 500); 3 Oct 2020 05:59:28 -0000 Delivered-To: apmail-ignite-dev-archive@ignite.apache.org Received: (qmail 83447 invoked by uid 500); 3 Oct 2020 05:59:27 -0000 Mailing-List: contact dev-help@ignite.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ignite.apache.org Delivered-To: mailing list dev@ignite.apache.org Received: (qmail 83431 invoked by uid 99); 3 Oct 2020 05:59:26 -0000 Received: from spamproc1-he-de.apache.org (HELO spamproc1-he-de.apache.org) (116.203.196.100) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 03 Oct 2020 05:59:26 +0000 Received: from localhost (localhost [127.0.0.1]) by spamproc1-he-de.apache.org (ASF Mail Server at spamproc1-he-de.apache.org) with ESMTP id 01D881FF39B for ; Sat, 3 Oct 2020 05:59:25 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamproc1-he-de.apache.org X-Spam-Flag: NO X-Spam-Score: -3.194 X-Spam-Level: X-Spam-Status: No, score=-3.194 tagged_above=-999 required=6.31 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FROM_LOCAL_DIGITS=0.001, FROM_LOCAL_HEX=0.331, NICE_REPLY_A=-3.576, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=disabled Authentication-Results: spamproc1-he-de.apache.org (amavisd-new); dkim=pass (1024-bit key) header.d=163.com Received: from mx1-ec2-va.apache.org ([116.203.227.195]) by localhost (spamproc1-he-de.apache.org [116.203.196.100]) (amavisd-new, port 10024) with ESMTP id m1sy1-xPwv_K for ; Sat, 3 Oct 2020 05:59:24 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=123.126.97.5; helo=mail-m975.mail.163.com; envelope-from=18624049226@163.com; receiver= Received: from mail-m975.mail.163.com (mail-m975.mail.163.com [123.126.97.5]) by mx1-ec2-va.apache.org (ASF Mail Server at mx1-ec2-va.apache.org) with ESMTPS id 46DCFBC286 for ; Sat, 3 Oct 2020 05:59:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=163.com; s=s110527; h=Subject:From:Message-ID:Date:MIME-Version; bh=w9sz6 79as4SSXKzOu1MNlnFu7kdOdV6sbpC/nqzcnXk=; b=i+bE8irFNqoBXJZMl/Siq IAH4AShkbA0o1Yc01UTPzeNVoc93aeTVZaViLMxZwBVdCGds9H2M1pkf9otJsHH9 SKz7O8gsubR+JGpUwBaO7oIMjgXzsbZQszPyGKLyEYk5uYnDKTMCPHkY3HCDu142 PvLe4DoFaRiIFknDYNnzMo= Received: from [192.168.31.97] (unknown [113.224.1.124]) by smtp5 (Coremail) with SMTP id HdxpCgAXHVEuE3hfHi7VPA--.85S2; Sat, 03 Oct 2020 13:59:11 +0800 (CST) Subject: Re: New Ignite Docs: Status and Incomplete Items To: dev@ignite.apache.org References: <325B1983-E1C9-4C46-B2BE-7174EA30C7A1@gmail.com> <0873a10c-9333-6885-3299-2042b9c70d8c@163.com> From: 18624049226 <18624049226@163.com> Message-ID: Date: Sat, 3 Oct 2020 13:59:10 +0800 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.3.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit X-CM-TRANSID:HdxpCgAXHVEuE3hfHi7VPA--.85S2 X-Coremail-Antispam: 1Uf129KBjvAXoW3Cr1xKr1xJr4kJw1kZFy3CFg_yoW8JF45Co WrXF4xA3W7GF1UAr1kCw1UGFy7G34Uur18Jryjqr1UGr1Ut3W7Jr1xAF1UXFZxAr4UJr47 Jr18J3WUAryUXF1rn29KB7ZKAUJUUUUU529EdanIXcx71UUUUU7v73VFW2AGmfu7bjvjm3 AaLaJ3UbIYCTnIWIevJa73UjIFyTuYvjxUDbo2UUUUU X-Originating-IP: [113.224.1.124] X-CM-SenderInfo: pvdktzbdstjqqrwthudrp/1tbiTRCyjVc7SdrHfwAAsl Hi Denis, Thank you very much for the detailed explanation. https://ignite.apache.org/docs/latest/installation/deb-rpm This document should be incomplete. At present, there are only descriptions related to DEB package, which is much less than the original one. In addition, with regard to Kubernetes, in fact, the services provided by various cloud service providers are generally similar. From the perspective of documents, most of the contents are repetitive. In addition, many users may still deploy Kubernetes in a private environment. So recombine these long documents into one general document, and then according to the differences of different service providers, there is another document to make it look clearer and save a lot of space. 在 2020/10/3 上午11:43, Denis Magda 写道: > 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 >> 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 >>>> 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 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 >> 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 >>>> wrote: >>>>>>>> Pavel, >>>>>>>> >>>>>>>> Alright, I'll do the porting of those pages and you'll take care of >>>>>>>> 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 >>>>>> 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 ... 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 >>>>>>>>>> написал(а): >>>>>>>>>>>>>> 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 >>>>>>>>>>>> >>