[Openstack] [api-site][{service}-api] duplicate content for documentation

Andreas Jaeger aj at suse.com
Wed Jan 29 07:44:51 UTC 2014


On 01/29/2014 05:52 AM, ZhiQiang Fan wrote:
> Hi, OpenStack document team,

The lsit for the documentation team is openstack-docs, not openstack.
Let me add them.

> I noticed that there are several repositories in OpenStack named
> {service}-api for api document, meanwhile there is a api-site for all
> services api document. The problem is that, many content is duplicate,
> for example, api-site contains keystone's api description, while
> identity-api has mostly same content too (I'm not sure if they are
> exactly same). I think it doesn't worth to maintain two project which
> have many same content.
> 
> And there are different site for this project, for example, to get
> keystone v2 api document, both
> http://docs.openstack.org/api/openstack-identity-service/2.0/content/
> and http://api.openstack.org/api-ref-identity.html#identity-v2 can work,
> but if there is a bug for document, we need to modify two repositories
> which seems unnecessary.

There is already content sharing between them, so while building the
api-site, we import documents from the specific api project sites. AFAIK
this is still ongoing work.

> So, is there any particular reason why we're in such situation, and is
> there any plan to improve it? (maybe one of them can be abandoned?)



Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the Openstack mailing list