From dev-return-34182-archive-asf-public=cust-asf.ponee.io@ignite.apache.org Mon May 7 21:22:37 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id C739D180648 for ; Mon, 7 May 2018 21:22:36 +0200 (CEST) Received: (qmail 75648 invoked by uid 500); 7 May 2018 19:22:35 -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 75627 invoked by uid 99); 7 May 2018 19:22:35 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 07 May 2018 19:22:35 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id A40DB1A2C1D for ; Mon, 7 May 2018 19:22:34 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.999 X-Spam-Level: * X-Spam-Status: No, score=1.999 tagged_above=-999 required=6.31 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=2, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001] autolearn=disabled Authentication-Results: spamd2-us-west.apache.org (amavisd-new); dkim=pass (2048-bit key) header.d=gridgain-com.20150623.gappssmtp.com Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id iOvsgM5ID44U for ; Mon, 7 May 2018 19:22:32 +0000 (UTC) Received: from mail-vk0-f42.google.com (mail-vk0-f42.google.com [209.85.213.42]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTPS id A54115FAD2 for ; Mon, 7 May 2018 19:22:31 +0000 (UTC) Received: by mail-vk0-f42.google.com with SMTP id x191-v6so5636916vke.10 for ; Mon, 07 May 2018 12:22:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gridgain-com.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=fDH0mes6txO8q7gObBHpTV3sQ2qBzC1JNmRkdh1Jth8=; b=JCbydcHYmFOfbsTYU2Z2BLhYme3OelHf3DbjZ4VUCAMXTT80vYuKNDjMXq6lh5Li94 gpE3Rd93Y+ly2EF+mqzOPW37UB4D6uLyEBsvsfMIJT9FtM2T1KBROFr0XH8k00Kax8Gn ZS3/7mAuqQkyJfJajRQ5wk1U1lhEXJGteHk9qKulVeXlzdIQ0bfiiL2+DgXl+E73ikq5 D29emJIlH2pXqlflkR43AQwkI7MdFcS5MOJbzQVCmXho+CSlS4Xjf8w1bGnfAbYVZ7/O whSINFJajvtoss3VUW8AK5igoxFh6/qjTfN7W+Yq4ALHdzHcZJQ+0JTzVsfJm2A5v8Et Sopg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=fDH0mes6txO8q7gObBHpTV3sQ2qBzC1JNmRkdh1Jth8=; b=i3U9AryRvT+4RxutWnA5UV8/WvDp/KKXQXFzv0GCTG6uRRYc+cgiEkJ/cL4zaIEJfg x9B/4RlPEGjDsMNUz1I6UpcwR7HT4XBslS1UBxnRTu4R4g3vAWIzn092qKhOoCsegeBq IeucREb/CJyuZ6xGcD466jmKI4GpRBdpE52M5sqBcg1vktuUmcym5sE+42u+gPErHOO2 eDfEKW2XH1a4KaJ+BIpOA9A0jL6JluOffsfmqu2TfR41kk9oO4xfZAbaaifkWfE7A0DA 3VRC8cr3gzOcbbepJGo6vfgiOjEjS1OsHy4rBFvPG+BFY1W7qgl0LijsJdECxw4gjExL utjA== X-Gm-Message-State: ALQs6tAwiQcSylgbr9nCJbAIRkhDb4LgcnE8PvtR+o67HLLIvZbLZotf tfkMAECqry6zFvl+kA37I7MlLkcFXBVRTQqGqGZ6/Q== X-Google-Smtp-Source: AB8JxZo45b7QVxrd0TlmquXhcNv3XZzK3aBa8CKdWGiK58JaWTLa1/L9CJR/pYgLXxWGfwmUNY5wWvczJeegQdyt5E8= X-Received: by 2002:a1f:8b8c:: with SMTP id n134-v6mr29892079vkd.150.1525720950379; Mon, 07 May 2018 12:22:30 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Vladimir Ozerov Date: Mon, 07 May 2018 19:22:19 +0000 Message-ID: Subject: Re: Migration guide To: dev@ignite.apache.org Cc: Andrey Gura Content-Type: multipart/alternative; boundary="000000000000463756056ba29745" --000000000000463756056ba29745 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Denis, Sounds good. Could you please share more info about new engine? =D0=BF=D0=BD, 7 =D0=BC=D0=B0=D1=8F 2018 =D0=B3. =D0=B2 21:00, Denis Magda <= dmagda@apache.org>: > Guys, > > It's planned to migrate to new documentation engine within 2.6 timeframe, > thus, I would suggest us storing migration guides in Github (together wit= h > doc sources) and publish as a part of the docs on Ignite web site. > > What do you think about this approach? > > - > Denis > > On Mon, May 7, 2018 at 6:20 AM, Vladimir Ozerov > wrote: > > > Igor, > > > > WIKI is the way to go. In addition we are discussing ticket review > > guidelines in separate thread at the moment. May be we will be able to > > include Migration Guide update there as well. > > > > On Mon, May 7, 2018 at 3:46 PM, Igor Sapego wrote: > > > > > Looks like a good idea to me. > > > > > > But I believe, if we decide to adopt this idea, then we > > > need to think how to enforce adding notes to migration > > > guide. > > > > > > The only way I can currently think of is a pretty obvious > > > one - adding corresponding instructions to a wiki [1]. > > > > > > Is there anything else we can do here? > > > > > > [1] - https://cwiki.apache.org/confluence/display/IGNITE/How+ > > to+Contribute > > > > > > Best Regards, > > > Igor > > > > > > On Mon, May 7, 2018 at 11:22 AM, Vladimir Ozerov > > > > wrote: > > > > > > > Igniters, > > > > > > > > We try to maintain API compatibility and keep default behavior > > unchanged > > > > between minor releases. But as product evolves, some APIs become > > > > deprecated, new best practices appear, and some defaults are change= d. > > > > > > > > We had a talk with Andrey Gura and he suggested to add *"Migration > > > Guide"* > > > > to our release cycle. This is a document where we will list all > > important > > > > changes since the last version and our recommendations how to use > them. > > > If > > > > done properly this should speedup adoption of new features and > > migration > > > to > > > > newer versions. > > > > > > > > Here are several examples from other vendors: > > > > 1) Hibernate - > > > > > https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2 > > > > 2) Play - https://www.playframework.com/documentation/2.6.x/ > > Migration26 > > > > > > > > I propose to start creating migration guides since the next release= , > > > Apache > > > > Ignite 2.6. > > > > > > > > For now let's decide whether community supports this idea, and if > yes - > > > how > > > > to publish it. I would propose to do it as follows: > > > > 1) Add MIGRATION_GUIDE document next to RELEASE_NOTES. This documen= t > > > should > > > > be updated by contributors during development. > > > > 2) After release: publish separate page next to release notes [1] > > > > 3) Add links to migration guide to download page [2] > > > > > > > > Please share your thoughts. > > > > > > > > Vladimir. > > > > > > > > [1] https://ignite.apache.org/releases/2.4.0/release_notes.html > > > > [2] https://ignite.apache.org/download.cgi > > > > > > > > > > --000000000000463756056ba29745--