[Openstack-docs] Status of renaming!

Andreas Jaeger aj at suse.com
Thu Sep 12 13:15:32 UTC 2013


On 09/12/2013 03:05 PM, Anne Gentle wrote:
> 
> 
> 
> On Thu, Sep 12, 2013 at 1:39 AM, Andreas Jaeger <aj at suse.com
> <mailto:aj at suse.com>> wrote:
> 
>     On 09/12/2013 02:40 AM, Anne Gentle wrote:
>     >
>     >
>     >
>     > On Mon, Sep 9, 2013 at 5:53 AM, Andreas Jaeger <aj at suse.com
>     <mailto:aj at suse.com>
>     > <mailto:aj at suse.com <mailto:aj at suse.com>>> wrote:
>     >
>     >     On 09/09/2013 09:32 AM, Andreas Jaeger wrote:
>     >     > We really need to double check that the books are correctly
>     >     published on
>     >     > the website - and links point from trunk/index.html to the new
>     >     version.
>     >     >
>     >     > Christian and myself are giving this a first try but please
>     double
>     >     check
>     >     > after our patches have gone in that everything really works,
>     >
>     >     Some of the manuals are building and publishing now, some
>     reviews are
>     >     open for others - and then there are a couple of locations to
>     update in
>     >     index.html where I'm not sure where the books get published:
>     >
>     >     Currently trunk/index.html patch has these paths which are wrong:
>     >    
>     http://docs.openstack.org/trunk/admin-guide-cloud/admin/content/: Does
>     >     not exist
>     >     http://docs.openstack.org/trunk/openstack-network/admin/content/ :
>     >     Old name
>     >     http://docs.openstack.org/trunk/openstack-ha/content/index.html :
>     >     Old name
>     >     http://docs.openstack.org/trunk/security-guide/content/ : Does
>     not exist
>     >
>     >     For many guides patches have been sent to fix problems
>     Christian and
>     >     myself noticed in pom.xml. These need a review and then
>     trunk/index.html
>     >     might need updating.
>     >
>     >     The Cloud Administrators Guide currently puzzles me. Anybody
>     knows what
>     >     the new URL is? Is there a way for me to figure this out
>     directly on
>     >     docs.o.o?
>     >
>     >
>     > I'll let you know how I'd figure it out:
>     >
>     > 1. pom.xml has
>     >
>     >
>     <targetDirectory>${basedir}/target/docbkx/webhelp/admin-guide-cloud</targetDirectory>
>     >
>     >                             <webhelpDirname>admin</webhelpDirname>
>     >
>     > that means it'll be locally built to
>     > target/docbkx/webhelp/admin-guide-cloud/admin/.
>     >
>     > But, in the Jenkins job definition in openstack-infra/config/
>     >
>     modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml
>     > you'll see:
>     >
>     >
>     >
>     > - ftp:
>     >           site: docs.openstack.org <http://docs.openstack.org>
>     <http://docs.openstack.org>
>     >           source: 'doc/admin-guide-cloud/target/docbkx/webhelp/**'
>     >           target: 'cloud-admin'
>     >           remove-prefix:
>     'doc/admin-guide-cloud/target/docbkx/webhelp/'
>     >           excludes: '**/*.xml,**/null*'
>     >
>     > So it's probably going to
>     >
>     > docs.openstack.org/admin-guide-cloud/admin/cloud-admin
>     <http://docs.openstack.org/admin-guide-cloud/admin/cloud-admin>
>     > <http://docs.openstack.org/admin-guide-cloud/admin/cloud-admin>
>     >
>     > Except it's not!
>     >
>     > So I go to Jenkins to look at the log of the job itself.
>     >
>     > https://jenkins01.openstack.org/view/Openstack-manuals/
>     >
>     > Looking at that and the changing directory commands in the log, it's
>     > going to
>     >
>     > http://docs.openstack.org/cloud-admin/admin-guide-cloud/content/
>     >
>     > I think we want it to go to /cloud-admin/content.
>     >
>     > So, change the pom.xml and it should be good to go.
> 
>     Anne, we discussed this on Tuesday on IRC and there you suggested to
>     change to /admin-guide-cloud/content and I thus proposed the following
>     for the Jenkins job: https://review.openstack.org/#/c/45938/
> 
>     If we want to got to /cloud-admin/content we need to change the Jenkins
>     job in another way, the pom.xml is fine AFAIU,
> 
> 
> 
> Ohhh I thought this looked familiar. :) 
> 
> I have to admit, I like /cloud-admin/content better, but not enough to
> do a 301 redirect from what you've done, so thanks for that!

The guide uses admin-guide-cloud as directory name, so that's why my
preference is for going with that URL - and having "guide" in the name
is consistent with the other directories.

My patch is not approved yet - we can still change things if you feel
strongly,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: 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-docs mailing list