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, 16 Jul 2019 21:35:43 +0900 Andreas Jaeger <aj at suse.com> 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. 

I am ok to move under openstack-manual also. Though we do not know the
future home of openstack-manual as docs team is moving towards SIG. But where ever
it will go, 'OpenStack api guide' can go with this.

 >  
 > > 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 
 >  
 > 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, 

Yeah, I remember there were no clear consesus of moving the api-ref/source to doc/source so
that might take time. publishing from api-ref/source as short term options looks good to me.

Thanks for initiating this discussion and caring about these sites. 

-gmann

 >  
 > Andreas 
 > --  
 >  Andreas Jaeger aj at suse.com Twitter: jaegerandi 
 >   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany 
 >    GF: Felix Imendörffer, Mary Higgins, Sri Rasiah 
 >        HRB 21284 (AG Nürnberg) 
 >     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126 
 >