Re: New documentation outline (was: Refactoring the documentation)
On Fri, Apr 4, 2008 at 12:39 PM, Adam <[EMAIL PROTECTED]> wrote: > Apologies in advance if this is out of scope of the discussion here, > but I just wanted to make sure that the existing documentation for > django 0.91 [1] isn't lost in the shuffle. It won't. I'll probably just flatten what's there into static HTML (well, flatpages, but yeah). It won't really fit into the new system without a similar refactoring, and that's kinda silly. Jacob --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
Apologies in advance if this is out of scope of the discussion here, but I just wanted to make sure that the existing documentation for django 0.91 [1] isn't lost in the shuffle. It appears that this documentation is at least somewhat outside the process of the rest of the documentation (0.95, 0.96 and trunk), so the plans for it aren't clear to me. It is a big help for those of us who are forced to stay in 0.91-land for some of our sites, including Ellington users like me. I use it all the time to remind myself of how things were done in prehistoric times, so I would hate to see it removed from the site. I realize this documentation exists inside the 0.91 checkout, but it helps to be able to call it up in a nicely rendered format from anywhere with a web connection. [1] http://www.djangoproject.com/documentation/0_91/ --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
> Once the refactor is complete we can start looking at writing new stuff. Sorry, posted my last message before seeing this. --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
> While I agree with the importance of having reusability tips, I would > certainly argue against putting it anywhere near django.contrib. When > I started working on my first app, I had unnecessary delusions of > getting into django.contrib when it was ready. I wouldn't want to > cause more people to expect that any and every third-party app has a > good shot at making it into django.contrib. Actually, that's exactly why I think it should be put there. The very beginning of the document could say what kept being repeated on this list a while back: "There's nothing special about django.contrib, you can create your application to live anywhere on the path, etc..." and "Start your project on an external hosting site like google code, and if it gets critical mass, and after a proven track record of maintenance, etc, it might be considered for inclusion." That way that question could be put to rest right where users would be looking for it. --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
On Wed, Apr 2, 2008 at 5:58 PM, SmileyChris <[EMAIL PROTECTED]> wrote: > I'd suggest moving install to a how-to rather than a topical guide. > Perhaps deployment could go under there, too? They seem closely > related. So the idea is that "topics" are for focused, core topical guides; "how-tos" are stuff that's cross-sectional, solves specific issues, and has lots of links to other specific docs. Yes, the points a bit fine; if anyone's got better ideas how to draw this distinction, I'd love to hear it! Jacob --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
On Wed, Apr 2, 2008 at 6:05 PM, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > One thing that struck me while looking over this list is that it might > be a good idea to add a section on best practices for writing reusable > apps. James Bennett's presentation at PyCon hit on some really good > main points that the section could cover. Maybe it could go under the > "django.contrib add-ons" section. Thoughts? For now, let's hold off adding new stuff. All the stuff labeled "new" on my outline is just new top-level outlines needed to lead folks to what we've already got. Once the refactor is complete we can start looking at writing new stuff. Jacob --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
On Wed, Apr 2, 2008 at 7:05 PM, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > One thing that struck me while looking over this list is that it might > be a good idea to add a section on best practices for writing reusable > apps. James Bennett's presentation at PyCon hit on some really good > main points that the section could cover. Maybe it could go under the > "django.contrib add-ons" section. Thoughts? While I agree with the importance of having reusability tips, I would certainly argue against putting it anywhere near django.contrib. When I started working on my first app, I had unnecessary delusions of getting into django.contrib when it was ready. I wouldn't want to cause more people to expect that any and every third-party app has a good shot at making it into django.contrib. -Gul --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
Looks really good--a lot cleaner and better laid out than the current docs! One thing that struck me while looking over this list is that it might be a good idea to add a section on best practices for writing reusable apps. James Bennett's presentation at PyCon hit on some really good main points that the section could cover. Maybe it could go under the "django.contrib add-ons" section. Thoughts? On Apr 2, 5:28 pm, "Jacob Kaplan-Moss" <[EMAIL PROTECTED]> wrote: > Hi folks -- > > I've finished making a new outline for the documentation based on my > proposal I posted last week. It's available online: > > HTML:http://toys.jacobian.org/django/new-docs-outline/ > OPML:http://toys.jacobian.org/django/new-docs-outline.opml > OmniOutliner:http://toys.jacobian.org/django/new-docs-outline.oo3.zip > > Feedback is welcome, especially of the form "you missed X". Nitpicking > will likely be ignored; I'm sure little stuff will leap out once we > actually start shuffling content around. And a warning: I feel very > strongly about getting this organization *right* here, and so I'm > likely to use my dictatorial fiat more freely in this process than I > usually do. > > The next step is to wrap up the Sphinx plugins I'll need to make this > all work. Once that's done the work can begin in ernest and I'll post > here looking for volunteers. > > Jacob --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
Re: New documentation outline (was: Refactoring the documentation)
I'd suggest moving install to a how-to rather than a topical guide. Perhaps deployment could go under there, too? They seem closely related. --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~--~~~~--~~--~--~---
