From issues-return-585-archive-asf-public=cust-asf.ponee.io@zookeeper.apache.org Sun Aug 4 12:48:02 2019 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 [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id D0A52180181 for ; Sun, 4 Aug 2019 14:48:01 +0200 (CEST) Received: (qmail 31839 invoked by uid 500); 4 Aug 2019 12:48:01 -0000 Mailing-List: contact issues-help@zookeeper.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@zookeeper.apache.org Delivered-To: mailing list issues@zookeeper.apache.org Received: (qmail 31830 invoked by uid 99); 4 Aug 2019 12:48:01 -0000 Received: from mailrelay1-us-west.apache.org (HELO mailrelay1-us-west.apache.org) (209.188.14.139) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 04 Aug 2019 12:48:01 +0000 Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 7B956E041B for ; Sun, 4 Aug 2019 12:48:00 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 0D477241C1 for ; Sun, 4 Aug 2019 12:48:00 +0000 (UTC) Date: Sun, 4 Aug 2019 12:48:00 +0000 (UTC) From: "maoling (JIRA)" To: issues@zookeeper.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Updated] (ZOOKEEPER-3282) a big refactor for the documetations MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/ZOOKEEPER-3282?page=3Dcom.atla= ssian.jira.plugin.system.issuetabpanels:all-tabpanel ] maoling updated ZOOKEEPER-3282: ------------------------------- Issue Type: Improvement (was: New Feature) > a big refactor for the documetations > ------------------------------------ > > Key: ZOOKEEPER-3282 > URL: https://issues.apache.org/jira/browse/ZOOKEEPER-3282 > Project: ZooKeeper > Issue Type: Improvement > Components: documentation > Reporter: maoling > Assignee: maoling > Priority: Major > > Hi guys: > I'am working on doing a big refactor for the documetations.it aims to=20 > - 1.make a better reading experiences and help users know more about zoo= keeper quickly,as good as other projects' doc(e.g redis,hbase). > - 2.have less changes to diff with the original docs as far as possible. > - 3.solve the problem when we have some new features or improvements,but= cannot find a good place to doc it. > =C2=A0 > The new catalog may looks kile this: > * is new one added. > ** is the one to keep unchanged as far as possible. > *** is the one modified. > -------------------------------------------------------------- > |---Overview > =C2=A0=C2=A0=C2=A0|---Welcome ** [1.1] > =C2=A0=C2=A0=C2=A0|---Overview ** [1.2] > =C2=A0=C2=A0=C2=A0|---Getting Started ** [1.3] > =C2=A0=C2=A0=C2=A0|---Release Notes ** [1.4] > |---Developer > =C2=A0=C2=A0=C2=A0|---API *** [2.1] > =C2=A0=C2=A0=C2=A0|---Programmer's Guide ** [2.2] > =C2=A0=C2=A0=C2=A0|---Recipes *** [2.3] > =C2=A0=C2=A0=C2=A0|---Clients * [2.4] > =C2=A0=C2=A0=C2=A0|---Use Cases * [2.5] > |---Admin & Ops > =C2=A0=C2=A0=C2=A0|---Administrator's Guide ** [3.1] > =C2=A0=C2=A0=C2=A0|---Quota Guide ** [3.2] > =C2=A0=C2=A0=C2=A0|---JMX ** [3.3] > =C2=A0=C2=A0=C2=A0|---Observers Guide ** [3.4] > =C2=A0=C2=A0=C2=A0|---Dynamic Reconfiguration ** [3.5] > =C2=A0=C2=A0=C2=A0|---Zookeeper CLI * [3.6] > =C2=A0=C2=A0=C2=A0|---Shell * [3.7] > =C2=A0=C2=A0=C2=A0|---Configuration flags * [3.8] > =C2=A0=C2=A0=C2=A0|---Troubleshooting & Tuning =C2=A0* [3.9] > |---Contributor Guidelines > =C2=A0=C2=A0=C2=A0|---General Guidelines * [4.1] > =C2=A0=C2=A0=C2=A0|---ZooKeeper Internals ** [4.2] > |---Miscellaneous > =C2=A0=C2=A0=C2=A0|---Wiki ** [5.1] > =C2=A0=C2=A0=C2=A0|---Mailing Lists ** [5.2] > -------------------------------------------------------------- > The Roadmap is: > 1.(I pick up it : D) > =C2=A01.1 write API[2.1], which includes the=EF=BC=9A=20 > =C2=A0=C2=A0=C2=A01.1.1 =C2=A0original API Docs which is a Auto-generate= d java doc,just give a link. > =C2=A0=C2=A0=C2=A01.1.2. Restful-api (the apis under the /zookeeper-cont= rib-rest/src/main/java/org/apache/zookeeper/server/jersey/resources) > =C2=A01.2 write Clients[2.4], which includes the:=20 > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A01.2.1 C client=20 > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A01.2.2 zk-python, kazoo > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A01.2.3 Curator etc....... > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0look at an example from: https://redis.io/= clients > # write Recipes[2.3], which includes the: > =C2=A0- integrate "Java Example" and "Barrier and Queue Tutorial"(Since = some bugs in the examples and they are obsolete=EF=BC=8Cwe may delete somet= hing) into it. > =C2=A0- suggest users to use the recipes implements of Curator and link = to the Curator's recipes doc. > =C2=A0 > # write Zookeeper CLI[3.6], which includes the: > =C2=A0- about how to use the zk command line interface [./zkCli.sh] > =C2=A0=C2=A0=C2=A0e.g ls /; get ; rmr;create -e -p etc....... > =C2=A0- look at an example from redis: https://redis.io/topics/rediscli > =C2=A0 > # write shell[3.7], which includes the: > =C2=A0=C2=A0- list all usages of the shells under the zookeeper/bin. (e.= g zkTxnLogToolkit.sh,zkCleanup.sh) > =C2=A0 > # write Configuration flags[3.8], which includes the: > =C2=A0=C2=A0- list all usages of configurations properties(e.g zookeeper= .snapCount):=20 > =C2=A0=C2=A0- move the original Advanced Configuration part of zookeeper= Admin.md into it. > =C2=A0=C2=A0=C2=A0=C2=A0look at an example from:https://coreos.com/etcd/= docs/latest/op-guide/configuration.html > =C2=A0=C2=A0 > # write Troubleshooting & Tuning[3.9], which includes the: > =C2=A0=C2=A0- move the original "Gotchas: Common Problems and Troublesho= oting" part of Administrator's Guide.md into it. > =C2=A0=C2=A0- move the original "FAQ" into into it. > =C2=A0=C2=A0- add some new contents =EF=BC=88e.g https://www.yumpu.com/e= n/document/read/29574266/building-an-impenetrable-zookeeper-pdf-github=EF= =BC=89. > =C2=A0=C2=A0look at an example from:https://redis.io/topics/problems > =C2=A0=C2=A0 =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2= =A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0= =C2=A0=C2=A0=C2=A0https://coreos.com/etcd/docs/latest/tuning.html > =C2=A0 > # write General Guidelines[4.1], which includes the: > =C2=A0- move the original "Logging" part of ZooKeeper Internals into it = as the logger specification. > =C2=A0- write specifications about code, git commit messages,github PR = =C2=A0etc ... > =C2=A0=C2=A0=C2=A0look at an example from: > =C2=A0=C2=A0=C2=A0http://hbase.apache.org/book.html#hbase.commit.msg.for= mat > =C2=A0 > # write Use Cases[2.5], which includes the: > =C2=A0- just move the context from: https://cwiki.apache.org/confluence/= display/ZOOKEEPER/PoweredBy into it. > =C2=A0- add some new contents.(e.g Apache Projects:Spark;Companies:twitt= er,fb) > =C2=A0 > -------------------------------------------------------------- > BTW: > - Any insights or suggestions are very welcomed.After the dicussions,I wi= ll create a series of tickets(An umbrella) > - Since these works can be done parallelly, if you are interested in them= , please don't hesitate,just assign to yourself, pick it up. (Notice: give = me a ping to avoid the duplicated work). -- This message was sent by Atlassian JIRA (v7.6.14#76016)