Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 6EE08200D2E for ; Tue, 31 Oct 2017 17:13:43 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 6D6D31609EC; Tue, 31 Oct 2017 16:13:43 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id B34E01609EB for ; Tue, 31 Oct 2017 17:13:42 +0100 (CET) Received: (qmail 81317 invoked by uid 500); 31 Oct 2017 16:13:41 -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 81306 invoked by uid 99); 31 Oct 2017 16:13:41 -0000 Received: from mail-relay.apache.org (HELO mail-relay.apache.org) (140.211.11.15) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 31 Oct 2017 16:13:41 +0000 Received: from [192.168.75.66] (c-67-160-238-197.hsd1.ca.comcast.net [67.160.238.197]) by mail-relay.apache.org (ASF Mail Server at mail-relay.apache.org) with ESMTPSA id 885311A02D2 for ; Tue, 31 Oct 2017 16:13:41 +0000 (UTC) From: Denis Magda Content-Type: multipart/alternative; boundary="Apple-Mail=_CC5EA180-69F7-403B-AF28-BD12AD1A73C5" Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) Subject: Re: Let's keep Apache Ignite docs up-to-date Date: Tue, 31 Oct 2017 09:13:41 -0700 References: <01DB7CED-B906-415E-9DF4-4B957CB852B3@apache.org> <041E2DBF-F2EC-42B2-B2C5-B1604D5CF415@apache.org> To: dev@ignite.apache.org In-Reply-To: Message-Id: <6B616A9D-398D-4D5D-BCC0-F8992F3191C5@apache.org> X-Mailer: Apple Mail (2.3273) archived-at: Tue, 31 Oct 2017 16:13:43 -0000 --Apple-Mail=_CC5EA180-69F7-403B-AF28-BD12AD1A73C5 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 Hi Pavel, The lack of smooth versioning between pages on readme.io = is redeemed with an easy to use editor. A doc writer = don=E2=80=99t need to grasp any markup language, commit changes to some = remote repo and check up final results. All the writer needs to do is to = open a page and update it seeing the changes immediately. Github is also a third-party site, so the docs won=E2=80=99t be hosted = on ASF infrastructure anyway. As a the one who prepares docs frequently, I can live with readme.io = .=20 =E2=80=94 Denis > On Oct 31, 2017, at 2:35 AM, Pavel Tupitsyn = wrote: >=20 > Hi Denis, >=20 > Are there plans to move away from readme.io? >=20 > * It is not properly versioned, which is very painful > * Documentation should be in Apache git, not on some third party site >=20 > Thoughts? >=20 > On Mon, Oct 30, 2017 at 11:24 PM, Denis Magda = wrote: >=20 >> Good point. Renamed: >> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document < >> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document> >>=20 >> =E2=80=94 >> Denis >>=20 >>> On Oct 30, 2017, at 12:37 PM, Dmitriy Setrakyan = >> wrote: >>>=20 >>> Thanks Denis! Any change we can rename the page to "How to = Document?". >>>=20 >>> On Mon, Oct 30, 2017 at 12:27 PM, Denis Magda = wrote: >>>=20 >>>> Igniters, >>>>=20 >>>> Our project is broadly documented so it=E2=80=99s becoming harder = and harder to >>>> keep the docs consistent and updated. During several last months we >> tried >>>> the new approach with some of community members and took it down on >> paper: >>>> https://cwiki.apache.org/confluence/display/IGNITE/Documentation >>>>=20 >>>> Please read it through and keep to it going forward or propose your >>>> changes if you=E2=80=99re like. Presently this approach proved to = be effective. >>>>=20 >>>> =E2=80=94 >>>> Denis >>=20 >>=20 --Apple-Mail=_CC5EA180-69F7-403B-AF28-BD12AD1A73C5--