[openstack-dev] Contributing to docs without Docbook -- YES you can!

Andreas Scheuring scheuran at linux.vnet.ibm.com
Tue Sep 30 07:20:21 UTC 2014


Hi Ageeleshwar, 
the links you provided are wordpress admin links and require a login. Is
there also a public link available?
Thanks
-- 
Andreas 
(irc: scheuran)


On Tue, 2014-09-30 at 09:33 +0530, Akilesh K wrote:
> Hi,
> 
> I saw the table of contents. I have posted documents on configuring
> openstack neutron-openvswitch-plugin, comparison between networking
> devices and thier linux software components and also about the working
> principles of neutron-ovs-plugin at layer 2 and neutron-l3-agent at
> layer 3 . My intention with the posts was to aid begginers in
> debugging neutron issues. 
> 
> 
> The problem is that I am not sure where exactly these posts fit in the
> topic of contents. Anyone with suggestions please reply to me. Below
> are the link to the blog posts
> 
> 
> 1. Comparison between networking devices and linux software components
> 
> 2. Openstack ovs plugin configuration for single/multi machine setup
> 
> 3. Neutron ovs plugin layer 2 connectivity
> 
> 4. Layer 3 connectivity using neutron-l3-agent
> 
> 
> I would be glad to include sub sections in any of these posts if that
> helps.
> 
> 
> Thank you,
> Ageeleshwar K
> 
> 
> On Tue, Sep 30, 2014 at 2:36 AM, Nicholas Chase <nchase at mirantis.com>
> wrote:
>         As you know, we're always looking for ways for people to be
>         able to contribute to Docs, but we do understand that there's
>         a certain amount of pain involved in dealing with Docbook.  So
>         to try and make this process easier, we're going to try an
>         experiment.
>         
>         What we've put together is a system where you can update a
>         wiki with links to content in whatever form you've got it --
>         gist on github, wiki page, blog post, whatever -- and we have
>         a dedicated resource that will turn it into actual
>         documentation, in Docbook. If you want to be added as a
>         co-author on the patch, make sure to provide us the email
>         address you used to become a Foundation member.
>         
>         Because we know that the networking documentation needs
>         particular attention, we're starting there.  We have a
>         Networking Guide, from which we will ultimately pull
>         information to improve the networking section of the admin
>         guide.  The preliminary Table of Contents is here:
>         https://wiki.openstack.org/wiki/NetworkingGuide/TOC , and the
>         instructions for contributing are as follows:
>         
>              1. Pick an existing topic or create a new topic. For new
>                 topics, we're primarily interested in deployment
>                 scenarios.
>              2. Develop content (text and/or diagrams) in a format
>                 that supports at least basic markup (e.g., titles,
>                 paragraphs, lists, etc.).
>              3. Provide a link to the content (e.g., gist on
>                 github.com, wiki page, blog post, etc.) under the
>                 associated topic.
>              4. Send e-mail to reviewers networking at openstacknow.com.
>              5. A writer turns the content into an actual patch, with
>                 tracking bug, and docs reviewers (and the original
>                 author, we would hope) make sure it gets reviewed and
>                 merged.
>         
>         Please let us know if you have any questions/comments.
>         Thanks!
>         
>         ----  Nick
>         -- 
>         Nick Chase 
>         1-650-567-5640
>         Technical Marketing Manager, Mirantis
>         Editor, OpenStack:Now
>         
>         _______________________________________________
>         OpenStack-dev mailing list
>         OpenStack-dev at lists.openstack.org
>         http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>         
> 
> 
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev




More information about the OpenStack-dev mailing list