[openstack-dev] [nova][docs] Concerns with docs migration

Doug Hellmann doug at doughellmann.com
Mon Aug 7 22:56:43 UTC 2017


Excerpts from Clark Boylan's message of 2017-08-07 14:04:33 -0700:
> On Wed, Aug 2, 2017, at 01:44 PM, Clark Boylan wrote:
> > On Wed, Aug 2, 2017, at 11:37 AM, Sean Dague wrote:
> > > On 08/02/2017 12:28 PM, Clark Boylan wrote:
> > > > On Wed, Aug 2, 2017, at 07:55 AM, Matt Riedemann wrote:
> > > >> Now that Stephen Finucane is back from enjoying his youth and 
> > > >> gallivanting all over Europe, and we talked about a few things in IRC 
> > > >> this morning on the docs migration for Nova, I wanted to dump my 
> > > >> concerns here for broader consumption.
> > > >>
> > > >> 1. We know we have to fix a bunch of broken links by adding in redirects 
> > > >> [1] which sdague started here [2]. However, that apparently didn't catch 
> > > >> everything, e.g. [3], so I'm concerned we're missing other broken links. 
> > > >> Is there a way to find out?
> > > > 
> > > > The infra team can generate lists of 404 urls fairly easily on the docs
> > > > server. This won't show you everything but will show you what urls
> > > > people are finding/using that 404.
> > > 
> > > If we could get a weekly report of 404 urls posted somewhere public,
> > > that would be extremely useful, because the easy ones based on git
> > > renames are done, and everything else is going to require human
> > > inspection to figure out what the right landing target is.
> > > 
> > 
> > I've pushed https://review.openstack.org/#/c/490175/ which will generate
> > a report each day for roughly the last day's worth of 404s. You should
> > be able to see them at https://docs.openstack.org/404s once the change
> > merges and the cron job fires.
> > 
> > You can see what that will look like (from my test runs) at
> > http://paste.openstack.org/show/617322/. Note that this isn't a complete
> > file because paste.openstack.org truncated it but you'll get the full
> > data from the wbeserver once this change merges.
> 
> http://files.openstack.org/docs-404s/ is now live (note it moved to
> http://files.openstack.org/docs-404s because that is where we are
> hosting raw bits of utility info for this hosting service). The current
> content there was just generated by running the scripts manually, but it
> should update daily at 0700UTC going forward.
> 
> Hope this helps,
> Clark
> 

Thanks Clark, that's going to be really useful.

Doug



More information about the OpenStack-dev mailing list