[openstack-dev] [infra][docs] Why Manila api-ref doc isn't published?

Eric Fried openstack at fried.cc
Tue Sep 5 12:30:40 UTC 2017

Agree with everything fungi has said here.

we want the official service type to be singular rather than plural.

And per the doc migration movement, we want the API references to live
at standard URLs based on their official service type.

So the official API reference should indeed be at [1], which it seems to
be, as you pointed out.

However, I also agree with your point that there are obviously stale
links in the world pointing to the plural version, and adding a redirect
would be a good idea while those get cleaned up.  I have proposed [2]
for this.

Please also note that, per my comment at [3], I feel we should be moving
toward a place where sources linking to API references should be
gleaning the URLs dynamically from the service-types-authority rather
than hardcoding them.

[1] https://developer.openstack.org/api-ref/shared-file-system/
[2] https://review.openstack.org/#/c/500792/


On 09/04/2017 01:24 PM, Jeremy Stanley wrote:
> On 2017-09-04 12:45:59 -0500 (-0500), Anne Gentle wrote:
>> I want to say there are a couple of in-progress patches to clear
>> this up.
>> https://review.openstack.org/#/c/495326/
>> and
>> https://review.openstack.org/#/c/495887/
> [...]
> Only insofar as the service-types-authority change is switching to
> match the URL where the document is now being published, but this
> doesn't actually address all the places where the old URL is still
> being used. At least that confirms for me that the new URL really is
> the one we want, so maybe the old "shared-file-systems" name should
> be added as an alias for the "shared-file-system" service (giving us
> a redirect as I understand it) and then cleanup of various uses for
> the old URL can happen at everyone's convenience?
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

More information about the OpenStack-dev mailing list