From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id C862927D for ; Fri, 2 Feb 2018 10:45:06 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id w129j5TX016659; Fri, 2 Feb 2018 18:45:05 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 1AA48EA8B6A; Fri, 2 Feb 2018 18:45:05 +0900 (JST) Received: from jcms-pop21.ecl.ntt.co.jp (jcms-pop21.ecl.ntt.co.jp [129.60.87.134]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 0FE18EA8B69; Fri, 2 Feb 2018 18:45:05 +0900 (JST) Received: from [IPv6:::1] (watercress.nslab.ecl.ntt.co.jp [129.60.13.73]) by jcms-pop21.ecl.ntt.co.jp (Postfix) with ESMTPSA id 0A5D6400B9F; Fri, 2 Feb 2018 18:45:05 +0900 (JST) References: <8006b50e-efa1-baf7-6474-e26c9403a84c@intel.com> <3145253.k4F035SiiW@xps> <201802020918.w129IBVm024328@ccmail03.silk.ntt-tx.co.jp> From: Yasufumi Ogawa Message-ID: <9333dc40-53f9-472c-8155-49e8be0ed2b5@lab.ntt.co.jp> Date: Fri, 2 Feb 2018 18:43:49 +0900 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.4.0 MIME-Version: 1.0 In-Reply-To: <201802020918.w129IBVm024328@ccmail03.silk.ntt-tx.co.jp> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-CC-Mail-RelayStamp: 1 To: Nakamura Hioryuki , Thomas Monjalon , spp@dpdk.org Cc: Ferruh Yigit , srv-apl-arch@lab.ntt.co.jp, x-fn-spp@sl.ntt-tx.co.jp X-TM-AS-MML: disable Subject: Re: [spp] [srv-apl-arch:9031] Re: [spp 02114] Re: Proposal for RST documentation support X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 02 Feb 2018 09:45:07 -0000 On 2018/02/02 18:18, Nakamura Hioryuki wrote: >> 01/02/2018 13:50, Ferruh Yigit: >>> On 2/1/2018 4:00 AM, Yasufumi Ogawa wrote: >>>> Hi, all >>>> >>>> SPP documentation is currently provided as markdown format. Although it >>>> is convenience for hosting on github, I think we need to prepare an >>>> official documentation as similar to other DPDK projects considering >>>> users. In addition, current documents are not so organized well and some >>>> of documents are poor for explanation and should be updated. >>>> >>>> I would like to send patches for replacing markdown documents to RST. It >>>> also includes make command support for compiling and cleaning html >>>> documents. >>>> $ make doc-html # compile html >>>> $ make doc-clean # clean generated documents >>>> >>>> As a trial, I have uploaded RST documents on readthedocs.io to be reviewed. >>>> http://spp.readthedocs.io/en/doc_rst/index.html >>> >>> I think this is good idea, I check the docs and looks pretty good. >>> >>>> >>>> If it is accpted, I would like to propose DPDK community to add a link >>>> to https://dpdk.org/doc as similar as pktgen-dpdk, or hosting it on >>>> dpdk.org. >>> >>> And I think this is good idea, cc'ed Thomas for comment. >> >> Yes we can host it on dpdk.org and automate the generation at each tag. Thanks, all! Good new for SPP to be hosted on the documentation's site. I will proceed to migrate documents to RST format. Hiroyuki, I would like to also migrate your SPP_VF documents. Thanks, Yasufumi > > Thanks Ferruh, Thomas and Yasufumi > > We all agree. > -- Yasufumi Ogawa NTT Network Service Systems Labs