<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Jan 23, 2017 at 9:54 AM, Tom Fifield <span dir="ltr"><<a href="mailto:tom@openstack.org" target="_blank">tom@openstack.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div bgcolor="#FFFFFF"><div><div class="gmail-h5">
<div class="gmail-m_5362320846349796196moz-cite-prefix">On 23/01/17 22:07, Tom Fifield wrote:<br>
</div>
<blockquote type="cite">On 23/01/17 22:04, Alexandra Settle wrote:
<br>
<blockquote type="cite">Hi everyone,
<br>
<br>
<br>
<br>
I would like to know if we have ever discussed appropriately
archiving
<br>
documentation after EOL date?
<br>
<br>
<br>
<br>
Tom triaged this bug
<br>
<a class="gmail-m_5362320846349796196moz-txt-link-freetext" href="https://bugs.launchpad.net/openstack-manuals/+bug/1658659" target="_blank">https://bugs.launchpad.net/<wbr>openstack-manuals/+bug/1658659</a> this
morning,
<br>
where the reporter noted that Icehouse documentation was not
found on
<br>
<a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>. The reporter noted that it was EOL, but was
404ing
<br>
and did not redirect to any archive folder.
<br>
<br>
<br>
<br>
Normally, I’m not too sure I’d be concerned about documentation
as far
<br>
back as Icehouse but as Tom notes in the bug, “With 9% of users
still
<br>
having Icehouse in production as at October 2016, I tend to
agree.” The
<br>
number of users was something I was unaware of – thank you, Tom.
<br>
<br>
<br>
<br>
Did we ever have a process in place to appropriately archive
<br>
documentation? Was there a reason we do not archive
documentation after
<br>
EOL dates?
<br>
<br>
<br>
<br>
If we were to archive documentation, I would recommend something
similar
<br>
to the following:
<br>
<br>
1. Anything that is EOL’d is converted to a PDF document
by the
<br>
release team (now we have the functionality to do so).
<br>
<br>
2. EOL branch is deleted as per normal.
<br>
<br>
3. Each document is branded with “End of life – cannot be
edited”
<br>
or something of that nature.
<br>
<br>
4. Kept in Archive folder on main docs.o.o page.
<br>
<br>
<br>
<br>
Thoughts? Or is there a piece of history here that I am missing?
<br>
<br>
</blockquote>
<br>
Related bug for the general issue:
<br>
<br>
<a class="gmail-m_5362320846349796196moz-txt-link-freetext" href="https://bugs.launchpad.net/openstack-manuals/+bug/1621685" target="_blank">https://bugs.launchpad.net/<wbr>openstack-manuals/+bug/1621685</a>
</blockquote>
<br></div></div>
Check this out, it's what Martin Paolo referred to in the above
report:<br><br></div></blockquote><div>snip </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div bgcolor="#FFFFFF">
<br>
<br>
Every page on the django docs has a hover-over listing the version
of the documentation being read. You mouse over it, and you can
choose to navigate back to that specific page for the release you
need - even the old/insecure/unsupported version from 2014. The URLs
are all standard too.<br>
<br>
So, that's best practice. How close can we get?<br>
<br>
<br></div></blockquote><div><br></div><div><div style="font-size:12.8px">This was an effort that needs more web dev: <a href="https://review.openstack.org/#/c/367725/" target="_blank">https://review.openstack.<wbr>org/#/c/367725/</a> Maybe Graham Hayes or Brian Moss can pick it back up?</div><div style="font-size:12.8px"><br></div><div style="font-size:12.8px">I'd also like to see a spec for the overall experience and actions needed. Thanks Alex for bringing it up.</div><div style="font-size:12.8px"><br></div><div style="font-size:12.8px">Anne</div></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div bgcolor="#FFFFFF">
<br>
<br>
Regards,<br>
<br>
<br>
Tom<br>
<br>
</div>
<br>______________________________<wbr>_________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.<wbr>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div dir="ltr"><div><br></div><div>Read my blog: <a href="https://justwriteclick.com" target="_blank">justwrite.click</a></div><div>Subscribe to Docs|Code: <a href="http://docslikecode.com" target="_blank">docslikecode.com</a> </div></div></div></div></div></div></div>
</div></div>