Archiving old documentation
Problem description
===================
As of the time of drafting, the docs.openstack.com site retention policy is
to publish the current release (Newton), plus two previous releases (Mitaka
and Liberty). This retention policy is in line with Foundation support
arrangements (see References).
According to the last User Survey (see References), 9% of production OpenStack
installations were still running Icehouse, 17% were running Juno, and 40% are
running Kilo.
This would indicate that a significant number of users are relying on
documentation that could potentially disappear in accordance with our current
retention policy.
Proposed change
===============
* At every new release, the release becoming EOL'd is moved to a read-only
archive folder (this can be completed with a script, TBD).
* The archive folder is made available online for people to download the
branch they require as a tar.gz file.
* Note somewhere obvious that documents in the archive are not editable, and
bugs raised against them will be closed WONTFIX.
Notes
-----
* This solution would cover all documentation in /$EOLRELEASE on
docs.
* Books that are already versioned (Install Guide, Config Ref, and CLI Ref)
Blueprint information
- Status:
- Complete
- Approver:
- Alexandra Settle
- Priority:
- High
- Drafter:
- Lana
- Direction:
- Approved
- Assignee:
- Lana
- Definition:
- Superseded
- Series goal:
- None
- Implementation:
- Not started
- Milestone target:
- pike
- Started by
- Completed by
- Petr Kovar
Related branches
Related bugs
Bug #1621685: Use stable version URLs for documentation | In Progress |
Bug #1658659: icehouse docs not found | Fix Released |
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Adding Archiving spec