Segments extension documentation does not explain why you would want to use it

Bug #1747028 reported by Ian Wells
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Wishlist
Unassigned

Bug Description

https://docs.openstack.org/neutron/pike/contributor/internals/segments.html

The segments extension says 'this lets you operate on segments', basically. It doesn't say what a segment is (or refer to external documentation that does) and it does not say why you might want an API to operate on them, nor what that API is. So it doesn't tell me what I would want this service plugin for or how I would use it if I worked out that I wanted it.

Tags: doc
Boden R (boden)
Changed in neutron:
status: New → Confirmed
importance: Undecided → Wishlist
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/neutron/+/869877

Changed in neutron:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.opendev.org/c/openstack/neutron/+/869877
Committed: https://opendev.org/openstack/neutron/commit/7751ac32a7e0119cdef7efccf2282f695f6055c3
Submitter: "Zuul (22348)"
Branch: master

commit 7751ac32a7e0119cdef7efccf2282f695f6055c3
Author: Brian Haley <email address hidden>
Date: Wed Jan 11 17:13:49 2023 -0500

    Add info on segments extension to contrib guide

    Add link from segments extension doc to routed networks spec,
    which explains the use case.

    Trivialfix
    Closes-bug: #1747028

    Change-Id: I8af639bc44924582135d3cc94196b3c9b3ca4b5d

Changed in neutron:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/neutron 22.0.0.0rc1

This issue was fixed in the openstack/neutron 22.0.0.0rc1 release candidate.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.