osdir.com


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[docs][tc][infra] what to do with developer.openstack.org and api-site?


On Tue, 2019-07-16 at 14:35 +0200, Andreas Jaeger wrote:
> On 16/07/2019 14.26, Ghanshyam Mann wrote:
> >  ---- On Mon, 15 Jul 2019 18:50:05 +0900 Thierry Carrez <thierry at openstack.org> wrote ----
> >  > Andreas Jaeger wrote: 
> >  > > [...] 
> >  > > I see the following options: 
> >  > >  
> >  > > 1) Retiring developer.openstack.org completely, this would mean we would 
> >  > > host the api-guides and api-references on docs.openstack.org (perhaps 
> >  > > with moving them into doc/source). If we go down this road, we need to 
> >  > > discuss what this means (redirects) and what to do with the Api-Guide 
> >  > > and the FirstApp guide. 
> > 
> > +1 on option 1. 
> > 
> > openstack api-guides (not the individual projects api-guides) make more sense under
> > os-api-ref which is nothing but overall openstack APIs state and less maintenance effort as you mentioned. 
> 
> I propose move it to openstack-manuals instead of os-api-ref to make
> publishing easier. os-api-ref is a tool used by others.
> 
> > api-references content is on project side ./api-ref/source. Do you mean to move them to
> > doc/source ? or cannot we host docs.openstack.org from the same existing ./api-ref/source location?
> 
> The idea some time ago was to move them to doc/source

Note that we can't do this because the API reference guides (and
release notes, since reno does that for us) shouldn't be versioned by
release, unlike the rest of the docs.

> But short-term we can just change the publishing jobs to publish to
> docs.openstack.org/api-reference instead of
> developer.openstack.org/api-reference,

Stephen

> Andreas