summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorJacob Kaplan-Moss <jacob@jacobian.org>2013-03-11 15:39:13 -0500
committerJacob Kaplan-Moss <jacob@jacobian.org>2013-03-11 15:39:13 -0500
commitfaabf3614e27c2b616bf4730272fafa9627652d8 (patch)
tree99d33f7479e38b83835d6872a0fa90448b814ad6 /docs/ref
parentf2f98abb955c83eca3ceea62d1711c80ae028d33 (diff)
parentd0561242699ed29527b9ab1dabe8a668e519eba5 (diff)
Merge branch 'deprecate-comments'
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/comments/custom.txt12
-rw-r--r--docs/ref/contrib/comments/example.txt12
-rw-r--r--docs/ref/contrib/comments/forms.txt14
-rw-r--r--docs/ref/contrib/comments/index.txt12
-rw-r--r--docs/ref/contrib/comments/models.txt12
-rw-r--r--docs/ref/contrib/comments/moderation.txt12
-rw-r--r--docs/ref/contrib/comments/signals.txt12
7 files changed, 85 insertions, 1 deletions
diff --git a/docs/ref/contrib/comments/custom.txt b/docs/ref/contrib/comments/custom.txt
index b4ab65bc2d..fd70a6a224 100644
--- a/docs/ref/contrib/comments/custom.txt
+++ b/docs/ref/contrib/comments/custom.txt
@@ -4,6 +4,18 @@ Customizing the comments framework
.. currentmodule:: django.contrib.comments
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
If the built-in comment framework doesn't quite fit your needs, you can extend
the comment app's behavior to add custom data and logic. The comments framework
lets you extend the built-in comment model, the built-in comment form, and the
diff --git a/docs/ref/contrib/comments/example.txt b/docs/ref/contrib/comments/example.txt
index e99c10f732..abf79c5f14 100644
--- a/docs/ref/contrib/comments/example.txt
+++ b/docs/ref/contrib/comments/example.txt
@@ -4,6 +4,18 @@
Example of using the built-in comments app
===========================================
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
Follow the first three steps of the quick start guide in the
:doc:`documentation </ref/contrib/comments/index>`.
diff --git a/docs/ref/contrib/comments/forms.txt b/docs/ref/contrib/comments/forms.txt
index c21a27bb9e..f2624ca870 100644
--- a/docs/ref/contrib/comments/forms.txt
+++ b/docs/ref/contrib/comments/forms.txt
@@ -5,6 +5,18 @@ Comment form classes
.. module:: django.contrib.comments.forms
:synopsis: Forms for dealing with the built-in comment model.
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
The ``django.contrib.comments.forms`` module contains a handful of forms
you'll use when writing custom views dealing with comments, or when writing
:doc:`custom comment apps </ref/contrib/comments/custom>`.
@@ -43,4 +55,4 @@ forms that you can subclass to reuse pieces of the form handling logic:
Handles the details of the comment itself.
This class contains the ``name``, ``email``, ``url``, and the ``comment``
- field itself, along with the associated validation logic. \ No newline at end of file
+ field itself, along with the associated validation logic.
diff --git a/docs/ref/contrib/comments/index.txt b/docs/ref/contrib/comments/index.txt
index d4e967b4b2..6db69d8168 100644
--- a/docs/ref/contrib/comments/index.txt
+++ b/docs/ref/contrib/comments/index.txt
@@ -7,6 +7,18 @@ Django's comments framework
.. highlightlang:: html+django
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
Django includes a simple, yet customizable comments framework. The built-in
comments framework can be used to attach comments to any model, so you can use
it for comments on blog entries, photos, book chapters, or anything else.
diff --git a/docs/ref/contrib/comments/models.txt b/docs/ref/contrib/comments/models.txt
index 78e7b92145..cae9c11971 100644
--- a/docs/ref/contrib/comments/models.txt
+++ b/docs/ref/contrib/comments/models.txt
@@ -5,6 +5,18 @@ The built-in comment models
.. module:: django.contrib.comments.models
:synopsis: The built-in comment models
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
.. class:: Comment
Django's built-in comment model. Has the following fields:
diff --git a/docs/ref/contrib/comments/moderation.txt b/docs/ref/contrib/comments/moderation.txt
index a7138dda53..796e257200 100644
--- a/docs/ref/contrib/comments/moderation.txt
+++ b/docs/ref/contrib/comments/moderation.txt
@@ -5,6 +5,18 @@ Generic comment moderation
.. module:: django.contrib.comments.moderation
:synopsis: Support for automatic comment moderation.
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
Django's bundled comments application is extremely useful on its own,
but the amount of comment spam circulating on the Web today
essentially makes it necessary to have some sort of automatic
diff --git a/docs/ref/contrib/comments/signals.txt b/docs/ref/contrib/comments/signals.txt
index ea901b6a95..f9df8980d7 100644
--- a/docs/ref/contrib/comments/signals.txt
+++ b/docs/ref/contrib/comments/signals.txt
@@ -5,6 +5,18 @@ Signals sent by the comments app
.. module:: django.contrib.comments.signals
:synopsis: Signals sent by the comment module.
+.. warning::
+
+ Django's comment framework has been deprecated and is no longer supported.
+ Most users will be better served with a custom solution, or a hosted
+ product like Disqus__.
+
+ The code formerly known as ``django.contrib.comments`` is `still available
+ in an external repository`__.
+
+ __ https://disqus.com/
+ __ https://github.com/django/django-contrib-comments
+
The comment app sends a series of :doc:`signals </topics/signals>` to allow for
comment moderation and similar activities. See :doc:`the introduction to signals
</topics/signals>` for information about how to register for and receive these