Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API
On Fri, Jul 24, 2015 at 04:27:57PM EDT, Cathy Zhang wrote: Do you know the process of getting the API spec published at http://specs.openstack.org/openstack/neutron-specs/? We can port the merged networking-sfc API spec and the latest patch over. Or we have to wait until we have some working codes for key functionality? Ah - see I keep forgetting that the API spec for SFC is currently a doc in the networking-sfc repo. I think that's OK for now, at least it's published and versioned somewhere. We'd need to ask someone from infra how we can get the doc/source tree published - most likely to docs.openstack.org/developer -- Sean M. Collins __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API
On Thu, Jul 23, 2015 at 10:45:50PM EDT, Paul Carver wrote: On a general topic of wiki cleanup, what's the preferred mechanism for documenting APIs? I prefer that the APIs be submitted in a spec, so that they are published on http://specs.openstack.org/openstack/neutron-specs/ At least there, changes can be reviewed by others - the problem with the wiki is it can be changed without any review. At least with neutron-specs it's versioned and there is discussion that is captured and preserved. I'm +1 on cleaning/deleting stuff from the wiki about the old SFC API -- Sean M. Collins __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API
Hi Paul, -Original Message- From: Paul Carver [mailto:pcar...@paulcarver.us] Sent: Thursday, July 23, 2015 7:46 PM To: openstack-dev@lists.openstack.org Subject: Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API On a general topic of wiki cleanup, what's the preferred mechanism for documenting APIs? Wiki page [1] largely duplicates the content of the spec in [2] I dislike duplication of information because it's likely to get out of sync. I'd rather use hyperlinks whenever possible. However, linking to a Gerrit review isn't the most end user friendly way of presenting an API. One option is to link to the GitHub version of the rendered RST file [3] but I'd like to know if there are any other preferred practices. Cathy Agree with you. Let's remove those duplicate sections and add the link to the rendered RST file [3] if there are no other preferred practices. Would you like to take care of this or I can clean this up? Thanks, Cathy [1] https://wiki.openstack.org/wiki/Neutron/APIForServiceChaining [2] https://review.openstack.org/#/c/192933/ [3] https://github.com/openstack/networking-sfc/blob/master/doc/source/api.rst __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API
Hi Sean, -Original Message- From: Sean M. Collins [mailto:s...@coreitpro.com] Sent: Friday, July 24, 2015 7:45 AM To: OpenStack Development Mailing List (not for usage questions) Subject: Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API On Thu, Jul 23, 2015 at 10:45:50PM EDT, Paul Carver wrote: On a general topic of wiki cleanup, what's the preferred mechanism for documenting APIs? I prefer that the APIs be submitted in a spec, so that they are published on http://specs.openstack.org/openstack/neutron-specs/ At least there, changes can be reviewed by others - the problem with the wiki is it can be changed without any review. At least with neutron-specs it's versioned and there is discussion that is captured and preserved. Cathy +1. Cathy Do you know the process of getting the API spec published at http://specs.openstack.org/openstack/neutron-specs/? We can port the merged networking-sfc API spec and the latest patch over. Or we have to wait until we have some working codes for key functionality? I'm +1 on cleaning/deleting stuff from the wiki about the old SFC API Cathy +1 too. -- Sean M. Collins __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Neutron][SFC] Wiki update - deleting old SFC API
On a general topic of wiki cleanup, what's the preferred mechanism for documenting APIs? Wiki page [1] largely duplicates the content of the spec in [2] I dislike duplication of information because it's likely to get out of sync. I'd rather use hyperlinks whenever possible. However, linking to a Gerrit review isn't the most end user friendly way of presenting an API. One option is to link to the GitHub version of the rendered RST file [3] but I'd like to know if there are any other preferred practices. [1] https://wiki.openstack.org/wiki/Neutron/APIForServiceChaining [2] https://review.openstack.org/#/c/192933/ [3] https://github.com/openstack/networking-sfc/blob/master/doc/source/api.rst __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
