stale glance page

Bug #1096126 reported by Anita Kuno
16
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Core Infrastructure
In Progress
Medium
Unassigned

Bug Description

this glance documentation page is stale yet it still exists: http://docs.openstack.org/developer/glance/client.html

this page was deleted from the git repo with this commit: https://github.com/openstack/glance/commit/37dc071

Tags: docs
Anne Gentle (annegentle)
Changed in openstack-ci:
assignee: nobody → Anne Gentle (annegentle)
Revision history for this message
Anne Gentle (annegentle) wrote :

I'll remove the stale pages, which is a bandaid fix -- can someone on the CI team work on changing the doc build jobs so that stale docs are removed automatically? I don't know how to do that portion of the real fix.

Revision history for this message
Anne Gentle (annegentle) wrote :

Removed stale pages, unassigning myself so a CI member can figure out what to do with the root cause bug.

Changed in openstack-ci:
assignee: Anne Gentle (annegentle) → nobody
James E. Blair (corvus)
Changed in openstack-ci:
status: New → Triaged
importance: Undecided → Medium
tags: added: docs
Changed in openstack-ci:
milestone: none → havana
Revision history for this message
Steven Deaton (sdeaton2) wrote :

The [possibly] related files are:

- jenkins-job-builder/jenkins_jobs/modules/publishers.py
.. though the ftp publisher already has 'clean-remote'; it is just not used.

- config/modules/jenkins/files/slave_scripts/run-docs.sh
.. this looks to be what processes the creation of the docs, through sphinx.

- config/modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml
.. among others (but mostly this config file I think?), this is what notes the ftp publisher is used, and passes any parameters to it... I would think it should just be a matter of adding the 'clean-remote: true' to the ftp areas as needed....

.....still looking.....

I'll put through the fix for this when I have the exact changes ready.... assigning.

Changed in openstack-ci:
assignee: nobody → Steven Deaton (sdeaton2)
Revision history for this message
Tom Fifield (fifieldt) wrote :

Hi Steven,

Any more thoughts on this one?

Revision history for this message
Steven Deaton (sdeaton2) wrote :

Yeah, sorry no updates all... I have been talking to Anne about this in email...

What I am thinking is... we can go ahead and wipe everything out (use the clean-remote option) but after a default/fallback 404 page is made and Apache is configured to use that page..

I'm working on the 404 now, and then will do this after that, so that the pages that would be wpied out by this would at least have a user-friendly look to them.

Revision history for this message
Steven Deaton (sdeaton2) wrote :

In looking to have this change put through, soon, I have made the changes to the file (config/modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml) which adds the 'clean-remote' flag, setting it to true, so that there are no more stagnant/stale files around for old docs, etc... This doesn't solve the fact that any pages not found will just get an error, since there is no default 404 page, as yet... but I'll get to that after this is live. I'll put my patch for review shortly.

Thanks.

-Steven

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to config (master)

Fix proposed to branch: master
Review: https://review.openstack.org/45395

Changed in openstack-ci:
status: Triaged → In Progress
Revision history for this message
Steven Deaton (sdeaton2) wrote :

I abandoned my last proposed change, and not sure where to go from here... but if anyone can suggest any ideas here, I wouldn't mind pursuring them.

Unassigning for now.... Thanks.

Changed in openstack-ci:
assignee: Steven Deaton (sdeaton2) → nobody
Revision history for this message
Jeremy Stanley (fungi) wrote :

Right, I suspect there will be a few hurdles with this using Jenkins and CloudSItes (which is probably part of why it hadn't been done previously). First, there's overlap with output from some doc jobs going into common locations, so wiping anything unknown to one doc build would inadvertently blow away content from other builds--this could be addressed by thoroughly siloing the docs publication such that it always uploads into non-overlapping destinations (per release and per job). Second, mass-deleting and replacing on publication will leave brief but frequent periods of time where content is unavailable on the site.

Alternatives to the above involve determining what additional upload mechanisms are available in CloudSites and installing (or possibly writing) a new Jenkins publisher plugin/utility, or switching to a different hosting platform which provides greater built-in fexibility for things like this.

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :
Jeremy Stanley (fungi)
Changed in openstack-ci:
milestone: havana → kilo
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.