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

Jeremy Stanley fungi at yuggoth.org
Mon Sep 4 17:27:32 UTC 2017

On 2017-09-04 11:10:44 +0800 (+0800), jun zhong wrote:
> Since we merged many patches [1][2] about api-ref doc in manila 3 weeks
> ago. But it cannot display in the Manila developer doc [3].   Does anyone
> have any idea about this? Do we need to do anything else or just waiting
> for automatic update? Thanks in advance.
> [1] https://review.openstack.org/#/c/491661/
> [2] https://review.openstack.org/#/c/492987/
> [3] https://developer.openstack.org/api-ref/shared-file-systems/#consistency-groups-since-api-v2-4

The https://developer.openstack.org/api-ref/shared-file-systems/
page states it was last updated Tue Jul 18 14:50:45 2017, commit
6a9b665; however there's also a different
https://developer.openstack.org/api-ref/shared-file-system/ page
which was updated more recently, Sat Sep 2 22:20:31 2017, commit
c9ab5b8. I found this by browsing
/afs/openstack.org/developer-docs/api-ref/ and saw the two distinct
directories so am assuming there's a typo somewhere leading to
content ending up in shared-file-system (singular) rather than the
expected shared-file-systems (plural).

Skimming http://codesearch.openstack.org/?q=shared-file-system shows
there's quite a lot of disagreement on which is correct... Manila's
api-ref-jobs service parameter was adjusted by
https://review.openstack.org/480719 to match the service_type from
(corresponding to when the old URL ceased being updated). The
{name}-api-guide job-template has baked-in assumptions that the
publication URL is derived from this service name.

It's unclear to me whether {name}-api-guide in
openstack-infra/project-config should be adjusted to require a
separate URL parameter, or whether the api_reference URL in
openstack/service-types-authority needs adjusting to agree with the
service_type there. I'm guessing we'd prefer the latter for
consistency, but in that case we probably also need to add a
redirect and clean up as many of the references to the old URL as
Jeremy Stanley
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 949 bytes
Desc: Digital signature
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20170904/a2150c23/attachment.sig>

More information about the OpenStack-dev mailing list