[spp] Proposal for RST documentation support

[spp] Proposal for RST documentation support

[Yasufumi Ogawa]

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

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.

Thanks,
Yasufumi

-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

Re: [spp] Proposal for RST documentation support

[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.

> 
> Thanks,
> Yasufumi
> 

Re: [spp] Proposal for RST documentation support

[Thomas Monjalon]

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.

Re: [spp] [spp 02114] Re: Proposal for RST documentation support

[Nakamura Hioryuki]

> 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, Thomas, Ferruh and Yasufumi

Of course, we all agree.

-- 
Nakamura Hioryuki <nakamua.hiroyuki@po.ntt-tx.co.jp>

Re: [spp] [srv-apl-arch:9031] Re: [spp 02114] Re: Proposal for RST documentation support

[Yasufumi Ogawa]

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

Re: [spp] Proposal for RST documentation support

[Thomas Monjalon]

01/02/2018 14:10, Thomas Monjalon:
> 01/02/2018 13:50, Ferruh Yigit:
> > > 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.

The SPP doc is now hosted on dpdk.org.
It is generated whenever a tag is pushed:
	http://doc.dpdk.org/spp/
All versions are available:
	http://doc.dpdk.org/spp-18.02/
	http://doc.dpdk.org/spp-18.05/

Note that the version number is not updated in the doc when tagging.
You should make it dynamic in conf.py as it is done for DPDK,
so you won't forget to update it again ;)

Re: [spp] Proposal for RST documentation support

[Yasufumi Ogawa]

> 01/02/2018 14:10, Thomas Monjalon:
>> 01/02/2018 13:50, Ferruh Yigit:
>>>> 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.
> 
> The SPP doc is now hosted on dpdk.org.
> It is generated whenever a tag is pushed:
> 	http://doc.dpdk.org/spp/
> All versions are available:
> 	http://doc.dpdk.org/spp-18.02/
> 	http://doc.dpdk.org/spp-18.05/
> 
> Note that the version number is not updated in the doc when tagging.
> You should make it dynamic in conf.py as it is done for DPDK,
> so you won't forget to update it again ;)
Hi Thomas,

Thanks a lot! I would like to update the version number.

Thanks,
Yasufumi
> 
> 
> 
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

Re: [spp] Proposal for RST documentation support

[Ferruh Yigit]

On 8/31/2018 7:47 PM, Thomas Monjalon wrote:
> 01/02/2018 14:10, Thomas Monjalon:
>> 01/02/2018 13:50, Ferruh Yigit:
>>>> 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.
> 
> The SPP doc is now hosted on dpdk.org.
> It is generated whenever a tag is pushed:
> 	http://doc.dpdk.org/spp/
> All versions are available:
> 	http://doc.dpdk.org/spp-18.02/
> 	http://doc.dpdk.org/spp-18.05/

Great! Thanks Thomas.

> 
> Note that the version number is not updated in the doc when tagging.
> You should make it dynamic in conf.py as it is done for DPDK,
> so you won't forget to update it again ;)
> 
> 

Re: [spp] Proposal for RST documentation support

[Ferruh Yigit]

On 9/4/2018 12:51 PM, Ferruh Yigit wrote:
> On 8/31/2018 7:47 PM, Thomas Monjalon wrote:
>> 01/02/2018 14:10, Thomas Monjalon:
>>> 01/02/2018 13:50, Ferruh Yigit:
>>>>> 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.
>>
>> The SPP doc is now hosted on dpdk.org.
>> It is generated whenever a tag is pushed:
>> 	http://doc.dpdk.org/spp/
>> All versions are available:
>> 	http://doc.dpdk.org/spp-18.02/
>> 	http://doc.dpdk.org/spp-18.05/
> 
> Great! Thanks Thomas.

Is there link from main dpdk.org page to spp docs?

Re: [spp] Proposal for RST documentation support

[Thomas Monjalon]

04/09/2018 13:53, Ferruh Yigit:
> On 9/4/2018 12:51 PM, Ferruh Yigit wrote:
> > On 8/31/2018 7:47 PM, Thomas Monjalon wrote:
> >> The SPP doc is now hosted on dpdk.org.
> >> It is generated whenever a tag is pushed:
> >> 	http://doc.dpdk.org/spp/
> >> All versions are available:
> >> 	http://doc.dpdk.org/spp-18.02/
> >> 	http://doc.dpdk.org/spp-18.05/
> > 
> > Great! Thanks Thomas.
> 
> Is there link from main dpdk.org page to spp docs?

Not yet, you should ask on web@dpdk.org.