[Discussion] Legacy documentation / Boken docs Django v1.2

[Areski]

Hi Folks,

I wanted to open a discussion regarding the following ticket https://code.djangoproject.com/ticket/23042

To summarize briefly, you may notice that we can search doc for Django version 1.2 (for example https://docs.djangoproject.com/search/?q=forms&release=4) but the links in the result won't work.

As Baptiste (IRC bmispelon) explained on IRC, we may have 2 approach to solve this problem:

1) Fix the docs builder for versions < 1.2 (at the moment the doc-building process is broken on old branches due to different version of Sphinx)

2) Discontinue older Django docs version and decide a policy regarding doc hosting

What do you think?

--
//Areski

[Tim Graham]

I'm in favor of discontinuing older version of the docs. I recently fixed the 1.3 documentation builder since there were several complaints, but no one has complained about 1.2.

[Tim Graham]

I just discontinued the 1.3 docs on docs.djangoproject.com, they are still available on django.readthedocs.org. Do you think we should keep it there or not?

[Florian Apolloner]

As long as it doesn't hurt we can keep em there -- remove as soon as they cause a problem ;)

[Tim Graham]

I removed the 1.4, 1.5, and 1.6 docs from docs.djangoproject.com today. They are still available on readthedocs. I've spent more than a couple hours recently debugging some problems related to documentation builds there. Some are described in https://github.com/django/djangoproject.com/issues/627, otherwise are related to elasticsearch (timeouts due to indexing so many documents, I think). I hope removing old docs versions will help to reduce the maintenance overhead of these tasks. Also, a stale link in the docs was pointing to a site with adult content. I backported the fix as far back as 1.4 today.

[Felipe Prenholato]

I was catch by that change today and found the docs in http://django.readthedocs.org/en/1.5.x/.

I wan't to suggest that for documentations that Django will remove from docs.djangoproject.com and from django.readthedocs.org we keep instead links to download PDFs / epubs / HTML zips in some place that is easy to find and so users can download it. Maybe some page like "Older versions" inside documentation.

Well, just a thought :).

Thx, Felipe.

Felipe Prenholato.

Home page: http://devwithpassion.com | http://chronosbox.org/blog
GitHub: http://github.com/chronossc/ | Twitter: http://twitter.com/chronossc

LinkedIn: http://br.linkedin.com/in/felipeprenholato/

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-develop...@googlegroups.com.
To post to this group, send email to django-d...@googlegroups.com.
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/8c2638b5-6604-4bd4-b470-9096aee14b69%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Marc Tamlyn]

I see no reason to remove old versions from readthedocs.

To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CADdUj3G%3DWaG7G3KJM-yZ_e21UsakW6K5ap3%2Brd1ScOxS8rqQWA%40mail.gmail.com.

[Daniel Chimeno]

IMHO We should keep the older version of docs somewhere, ReadTheDocs it's fine.

But we can't only remove them. We may notice the users instead of returning a simple 404.

There are a lot of people still using those versions.

To keep happy search engines, we should give a 301 to somewhere, not sure if we should do it or not.

[Sergei Maertens]

+1

Yes, you should upgrade, but the reality is that some people have old versions lying around. They should be _somewhere_, be it 'hard' to find. A PDF or Epub is fine as well, that removes the need to maintain the build of the docs for unsupported versions.

[Noemi]

Well, that made me sad (and confused) yesterday when I suddenly couldn't find docs via either djangoproject.com OR Google for some topics for 1.4 (we're in the process of upgrading a large and crufty codebase from 1.4 to 1.8 via 1.6).

Please at least don't eliminate the readthedocs versions in favor of downloads -- searchability is extremely important for those of us trying to work with older codebases and bring them up to date!

[Fred Stluka]

I vote for a 301 to the matching ReadTheDocs page.

I recently had to manually update these bookmarks:

- Django 1.4 Docs
  - Old: https://docs.djangoproject.com/en/1.4/
  - New: https://django.readthedocs.org/en/1.4/

- Django 1.4 API Ref
  - Old: https://docs.djangoproject.com/en/1.4/ref/
  - New: https://django.readthedocs.org/en/1.4/ref/

- Django 1.4 Doc Detailed TOC
  - Old: https://docs.djangoproject.com/en/1.4/contents/
  - New: https://django.readthedocs.org/en/1.4/contents.html

- Django 1.4 Doc Index
  - Old: https://docs.djangoproject.com/en/1.4/genindex/
  - New: https://django.readthedocs.org/en/1.4/genindex.html

- Django 1.4 Module Index
  - Old: https://docs.djangoproject.com/en/1.4/py-modindex/
  - New: https://django.readthedocs.org/en/1.4/py-modindex.html

- Django 1.4 Testing
  - Old: https://docs.djangoproject.com/en/1.4/topics/testing/
  - New: https://django.readthedocs.org/en/1.4/topics/testing.html

- Django 1.4 Testing Assertions
  - Old: https://docs.djangoproject.com/en/1.4/topics/testing/#assertions
  - New: https://django.readthedocs.org/en/1.4/topics/testing.html#assertions

- Django 1.5 Docs
  - Old: https://docs.djangoproject.com/en/1.5/
  - New: https://django.readthedocs.org/en/1.5.x/

- Django 1.6 Docs
  - Old: https://docs.djangoproject.com/en/1.6/
  - New: https://django.readthedocs.org/en/1.6.x/

--Fred

---

Fred Stluka -- mailto:fr...@bristle.com -- http://bristle.com/~fred/
Bristle Software, Inc -- http://bristle.com -- Glad to be of service!
Open Source: Without walls and fences, we need no Windows or Gates.

---

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-develop...@googlegroups.com.
To post to this group, send email to django-d...@googlegroups.com.
Visit this group at https://groups.google.com/group/django-developers.

To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/ba425446-63fb-4039-b238-443adac456ed%40googlegroups.com.

[Tim Graham]

I guess I'm not strongly opposed if someone wants to do that, but I don't think I can justify spending time on the DSF's dime to help out users of unsupported versions.

--Fred

---

Fred Stluka -- mailt...@bristle.com -- http://bristle.com/~fred/

[Florian Apolloner]

On Thursday, February 18, 2016 at 4:24:09 PM UTC+1, Tim Graham wrote:

I guess I'm not strongly opposed if someone wants to do that, but I don't think I can justify spending time on the DSF's dime to help out users of unsupported versions.

+1

[Eric Holscher]

Happy to help with this. We can move the RTD builds to using Sphinx HTMLDir, and then redirects won't be necessary for the page titles, at least.