Commit Graph

302 Commits

Author SHA1 Message Date
Rodolfo Carvalho 2b6436e2d5 Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
Tim Graham 1f5f015c32 Fixed spelling mistakes in docs. 2014-02-28 21:03:46 -05:00
Tim Graham 7f2505ad9e Fixed doc typos. 2014-02-28 11:44:03 -05:00
Martin Matusiak d399731bf2 Fixed #22007 -- Fixed cbv docs - make imports consistent
Thanks to trac user kinjal.dixit for the report.
2014-02-22 14:39:09 +01:00
Adrian Holovaty 660b7e7000 Removed BDFL stuff from docs/internals/contributing/bugs-and-features.txt 2014-01-13 10:32:09 -06:00
Tim Graham 9953e98e6a Fixed #21701 -- Improved testing doc titles and added testing/tools.txt.
Thanks cjerdonek for the suggestion.
2013-12-31 08:14:09 -05:00
Yaroslav Halchenko 80027d2c38 Unified listing of shell commands/code
- use code-block:: bash
- prefix the command with $
2013-12-25 15:19:14 -05:00
Aymeric Augustin 9b8192ce51 Updated a few doc paragraphs following the app-loading refactor. 2013-12-24 17:20:11 +01:00
Bouke Haarsma bed52afee7 Removed usage of to-be-deprecated ADMIN_FOR setting in contributing docs 2013-12-14 16:49:25 +01:00
Simon Charette c047dda057 Removed an erroneous leading slash introduced by a626bdf648a. 2013-12-08 13:18:53 -05:00
Claude Paroz 626bdf648a Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
Alasdair Nicol c75dd664cf Fixed #21538 -- Added numpy to test/requirements/base.txt
Thanks Tim Graham for the report
2013-12-02 13:37:59 -05:00
Alex Gaynor c0a2daad78 Documented the house style for gender neutral pronouns. 2013-11-30 08:31:58 -05:00
Cody Scott 4a54b69e88 Fixed sentence structure in docs/internals/contributing/triaging-tickets.txt 2013-11-22 09:07:10 -05:00
Tim Graham 98de90d3d8 Fixed spelling of compatibility. 2013-11-09 10:17:17 -05:00
Tim Graham 14c1872d29 Recommended flake8 to check coding style. 2013-11-09 06:39:55 -05:00
Claude Paroz e953c78eeb Fixed #16969 -- Don't connect to named database when possible
Thanks Andreas Pelme for the report and initial patch, and
Aymeric Augustin, Shai Berger and Tim Graham for the reviews.
2013-11-09 09:42:17 +01:00
Tim Graham c573d6de17 Fixed #19941 -- Removed sys.path hack when running the test suite.
Thanks jezdez for the suggestion.
2013-10-23 18:27:06 -04:00
Tim Graham 1dae4ac177 Whitespace cleanup.
* Removed trailing whitespace.
* Added newline to EOF if missing.
* Removed blank lines at EOF.
* Removed some stray tabs.
2013-10-10 16:49:20 -04:00
Tim Graham 9700194195 Fixed #21222 - Documented that 'default' and 'other' must be different databases when running tests.
Thanks vernondcole for the suggestion.
2013-10-09 11:42:27 -04:00
Unai Zalakain 3895d8899d Fixed #21213 -- Added docs for Django's mailing lists.
Added docs/internals/mailing-lists.txt documenting the use of django's
mailing lists. All references across docs changed to point to this page.

The referencing makes use of substitution because there's no way to make
a :ref: link in a non-inline fashion in Sphinx. It also makes use of
rst_epilog Sphinx conf for making this substitutions across all the
docs.
2013-10-04 10:00:36 -04:00
Baptiste Mispelon 42b9feb2e7 Fixed wording in unit tests documentation. 2013-09-25 18:24:30 +02:00
Rogério Yokomizo 1b4b710355 Fixed #21141 -- Update Sphinx URL
Updated Sphinx URL from http://sphinx.pocoo.org/ to http://sphinx-doc.org/.
2013-09-22 14:44:09 -03:00
Tim Graham 5be56d0e0d Fixed #21024 -- Documented how to deprecate a feature. 2013-09-17 13:23:32 -04:00
Kevin Christopher Henry 990ce9aab9 Documentation -- added instructions on working with pull requests
Since non-core contributors are asked to review patches, instructions
on working with pull requests were added to the Working with Git and
GitHub page (based on the existing instructions in the core
committers page).
2013-09-13 08:26:46 -04:00
Tim Graham cd4068f359 Fixed instructions for running a subset of tests. 2013-09-06 14:31:27 -04:00
Eric Boersma 4d13cc56de Fixed #21035 -- Changed docs to treat the acronym SQL phonetically.
The documentation and comments now all use 'an' to
refer to the word SQL and not 'a'.
2013-09-05 20:14:58 -04:00
micahhausler 93dd31cadf Fixed #21047 -- Added CLA mesage on the new contributor advice doc 2013-09-05 17:52:36 -04:00
Matt Robenolt 08e7a64369 Updated instructions for running contrib tests. 2013-08-27 08:21:42 -04:00
Andrew Godwin b6a957f0ba Merge remote-tracking branch 'core/master' into schema-alteration
Conflicts:
	docs/ref/django-admin.txt
2013-08-19 18:30:48 +01:00
Daniele Procida e868eaf680 clarified misleading wording about squashing commits 2013-08-10 22:24:24 +01:00
Andrew Godwin de64c4d6e9 Merge remote-tracking branch 'core/master' into schema-alteration
Conflicts:
	django/core/management/commands/flush.py
	django/core/management/commands/syncdb.py
	django/db/models/loading.py
	docs/internals/deprecation.txt
	docs/ref/django-admin.txt
	docs/releases/1.7.txt
2013-08-09 14:17:30 +01:00
Andrew Godwin f8297f6323 More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
Anssi Kääriäinen b2314d9e1e Fixed #19941 -- Modified runtests.py to make running the tests easier.
1. Automatically use tests/../django as the Django version.
2. If settings aren't provided through --settings or DJANGO_SETTINGS_MODULE)
   then use test_sqlite.
2013-07-24 07:33:03 -04:00
Tim Graham 77856dc875 Added some missing test requirements in the docs; refs #19196 2013-07-10 12:01:17 -04:00
Tim Graham 4d92a0bd86 Fixed #19196 -- Added test/requirements 2013-07-10 09:24:05 -04:00
Jeremy Dunck 9aed3201aa Clarified trac patch-related field meaning
There was some confusion on the mentorship list as to whether 'needs tests'
meant that a given ticket might not need tests, as opposed to flagging
a specific patch as still needing tests.

This commit seeks to clarify that confusion.
2013-07-07 21:17:10 -07:00
Claude Paroz 7442eb1a24 Fixed #20224 -- Update docs examples which mention __unicode__
Thanks Marc Tamlyn and Tim Graham for the review.
2013-07-05 19:27:07 +02:00
SusanTan b0907d66a5 Fixed #20524 - Described keywords in triaging contrib doc. 2013-06-23 15:41:24 -04:00
russkel f80b1063e4 Update submitting-patches.txt
Few quick fixes to the terminology in order to match what is used on the Django Trac at the moment.
2013-06-08 14:53:27 +09:00
Tim Graham 490672f057 Tweaked unit test 'quick start' explanation.
Thanks Jeremy Dunck.
2013-05-20 13:45:32 -04:00
Aymeric Augustin a9b98f59aa Clarified when triagers should close tickets as needsinfo.
https://groups.google.com/d/msg/django-developers/dyldP9kFADc/rHTlRBVEP8MJ
2013-05-19 15:24:10 +02:00
Claude Paroz 8f7276b782 Updated Transifex links to the Django project
Translations for the Django framework are now hosted on the
django-core Transifex project, and the django project is only
dedicated to a team-only hub project.
2013-04-25 10:35:51 +02:00
Juan Catalano 4e25198ec2 Fixed #20104 -- Changed VersionDirective in order to avoid ambiguity.
As explained in ticket #20104, the use of versionchanged/versionadded
was confusing.

To solve this ambiguity these directives no longer accept a second
argument but now they only receive the version number (1st arg) and then
a content with the proper comment.
2013-04-20 17:18:21 +02:00
Julien Phalip 68d6c52ed6 Turned the triage attributes to actual sections so they can be more easily linked to in the documentation. 2013-04-10 17:11:26 -07:00
Preston Holmes 18255779e9 Added some further guidance to "accepted" triage stage
Now that DDN is gone, I felt it was worth some extra language
about what "accepted" means, and qualify what it means to be "safe"
to start writing a patch.
2013-04-09 22:39:36 -07:00
Aymeric Augustin 4a7292df3b Removed references to the DDN triage state.
Rephrased "How can I help with triaging?" a bit to reflect the current
practice.
2013-04-08 20:33:52 +02:00
Florian Apolloner 28e545c4b3 Updated docs to reflect new tests layout.
Thanks to Ramiro Morales for the initial patch.
2013-02-26 15:00:16 +01:00
Carl Meyer 906dc8522a Fixed #19854 -- Turn Django's own Selenium tests off by default. 2013-02-25 10:14:42 -07:00
Zbigniew Siciarz 1cd2f51eb4 Added test runner option to skip Selenium tests (#19854). 2013-02-23 17:45:26 +01:00
Julien Phalip c9c40bc6bc Fixed #19333 -- Moved compress.py outside of the admin static folder. Thanks to camilonova, Russell Keith-Magee, Aymeric Augustin and Ramiro Morales for the feedback. 2013-02-02 15:01:32 -08:00
Tim Graham ee26797cff Fixed typos in docs and comments 2013-01-29 10:55:55 -07:00
Tim Graham eaa716a413 Fixed #19639 - Updated contributing to reflect model choices best practices.
Thanks charettes.
2013-01-24 07:59:39 -05:00
Tim Graham 9b5f64cc6e Fixed #19516 - Fixed remaining broken links.
Added -n to sphinx builds to catch issues going forward.
2013-01-02 18:32:57 -05:00
Aymeric Augustin ebd2598596 Removed django.contrib.markup. 2012-12-29 21:59:07 +01:00
Aymeric Augustin 9d62220e00 Fixed #15516 -- Updated the ticket life cycle diagram. 2012-12-22 19:01:55 +01:00
Ramiro Morales d19109fd37 Fixed #19497 -- Refactored testing docs.
Thanks Tim Graham for the review and suggestions.
2012-12-21 21:59:06 -03:00
Aymeric Augustin d5ed81c795 Fixed #19389 -- Docs on the location of contrib apps tests. 2012-12-08 19:47:53 +01:00
Tim Graham 7058b595b6 Fixed #16779 - Added a contributing tutorial
Thank-you Taavi Taijala for the draft patch!
2012-11-17 14:10:25 -05:00
Preston Holmes aee9c7b094 Added a note and link to CLA from contributing docs 2012-11-04 12:25:48 -08:00
Tim Graham 5c143cb340 Fixed #19180 - Clarified policy regarding older versions of the docs. 2012-10-25 17:55:42 -04:00
Adrian Holovaty 72efdc4d92 Merge pull request #436 from ddbeck/patch-1
Removed heteronormativity from coding style doc
2012-10-15 07:45:27 -07:00
Claude Paroz a451d2b4a2 Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
Tim Graham 06f5da3d78 Fixed #16817 - Added a guide of code coverage to contributing docs.
Thanks Pedro Lima for the draft patch.
2012-10-11 06:11:52 -04:00
Daniel D. Beck f315006d50 Remove heteronormativity from coding style doc 2012-10-10 20:38:48 -03:00
Preston Holmes 14681eaa53 Fixed #19045 -- removed 'fixed on a branch' from triage docs 2012-10-01 09:00:41 -07:00
Preston Holmes 1df58968a4 Added a note regarding interaction between GitHub and Trac Plugin 2012-09-27 13:19:04 -07:00
Florian Apolloner 9e7b5ba50f Removed missplaced label in the docs. 2012-08-12 12:43:05 +02:00
James Bennett 50c41e77e8 Put all the security-related notes in the same notice box. 2012-08-07 16:28:12 -04:00
James Bennett 1ef1bceb3b Add new security-policy documentation.
This formally describes our policies on reporting, notification and
disclosure of security issues, and provides a detailed explanation of
our full security-response process, for reference purposes.
2012-08-07 16:06:34 -04:00
Claude Paroz 8a5d1a6b93 Updated obsolete links in the documentation 2012-06-28 10:49:07 +02:00
Julien Phalip 79ef3901da Fixed the path to the admin's compress.py script in the doc. 2012-06-16 16:23:03 -07:00
Aymeric Augustin 7ae66517c1 Fixed an error in a git command. 2012-06-08 12:14:01 +02:00
Aymeric Augustin d2ad3b0f96 Clarified the purpose of the pull requsets docs
One is for the community, the other for the core team.

Thanks Reinout van Rees for the report.
2012-06-08 11:53:54 +02:00
Aymeric Augustin 1f203f84d0 Explained an alternative way to fetch a branch.
This avoids adding each contributor as a remote.

Thanks Fruneau for the report.
2012-06-08 11:40:33 +02:00
Aymeric Augustin 329bb9296f Proof-read the new contributing guide.
Many thanks to Daniele Procida.
2012-06-08 11:26:22 +02:00
Luke Plant f269f30544 Small corrections to committing-code docs 2012-06-08 00:02:52 +01:00
Aymeric Augustin 90fb6a4648 Fixed #18436 -- Updated contributing docs for git.
Most of the credit for this large patch goes to Anssi Kääriäinen.
Many thanks to all the people who contributed to the discussion.
2012-06-07 18:54:43 +02:00
Adrian Holovaty 87ff89d12d Fixed #17933 -- Added intro note to writing-documentation.txt
Based on initial patch by Thomas Westfeld
2012-06-07 11:32:28 -05:00
Aymeric Augustin c28e700c7e Removed references to changes made in 1.2.
Thanks Florian Apolloner for the patch.
2012-06-07 15:02:35 +02:00
Claude Paroz 21fb1c59c3 Updated some outdated external URLs in docs.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17710 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-14 07:41:02 +00:00
Claude Paroz 78638a9a51 Replaced http by https in djangoproject.com links
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17703 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-13 17:53:31 +00:00
Adrian Holovaty d694f17536 Made some small edits to localization docs from [17690]
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17693 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-12 23:05:16 +00:00
Jannis Leidel db512b4d8c Fixed the localization docs a little to point to the correct Transifex URL. Also reworded it a bit to follow the site's new UI.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17690 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-12 22:00:44 +00:00
Aymeric Augustin c0e73a4909 Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17636 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-03 09:11:54 +00:00
Adrian Holovaty 9fa536dc4f Added note to coding-style.txt about how we should NOT be religious about line lengths.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17539 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-02-17 20:03:40 +00:00
Aymeric Augustin 5b37a02ba3 Used Sphinx markup for PEPs and fixed a typo in the 1.4-beta-1 release notes.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17536 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-02-16 18:27:42 +00:00
Timo Graham ca984aa50a Fixed #17334 - Documented the commit message style for backports; thanks krzysiumed for the draft patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17294 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-30 12:52:49 +00:00
Julien Phalip 2f02a05ffb Fixed #2879 -- Added support for the integration with Selenium and other in-browser testing frameworks. Also added the first Selenium tests for `contrib.admin`. Many thanks to everyone for their contributions and feedback: Mikeal Rogers, Dirk Datzert, mir, Simon G., Almad, Russell Keith-Magee, Denis Golomazov, devin, robertrv, andrewbadr, Idan Gazit, voidspace, Tom Christie, hjwp2, Adam Nelson, Jannis Leidel, Anssi Kääriäinen, Preston Holmes, Bruno Renié and Jacob Kaplan-Moss.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17241 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-12-22 08:33:58 +00:00
Aymeric Augustin 67e6e0fcf3 Fixed #17087 -- Re-organized the i18n docs to reduce confusion between USE_I18N/USE_L10N and the concepts of internationalization/localisation. Re
moved some duplicate content.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@17026 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-10-22 17:17:57 +00:00
Luke Plant d1e5c55258 Fixed many more ReST indentation errors, somehow accidentally missed from [16955]
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16983 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-10-14 00:12:01 +00:00
Ramiro Morales 932b1b8d6d Converted links to external topics so they use intersphinx extension markup.
This allows to make these links more resilent to changes in the target URLs.
Thanks Jannis for the report and Aymeric Augustin for the patch.

Fixes #16586.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16720 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-09-04 21:17:30 +00:00
Idan Gazit 6dc48a735c Added guidelines for reporting UI-related bugs & feature requests.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16707 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-28 14:43:51 +00:00
Malcolm Tredinnick e0ae9db272 Small typo fix for how to claim a ticket in Trac.
Patch from Audrey Roy, fixes #16670.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16696 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-26 09:44:40 +00:00
Malcolm Tredinnick 499f01842e Add a note about discouraging whitespace- or formatting-only patches.
We follow the python-dev path here. Deliberately.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16691 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-26 05:28:58 +00:00
Julien Phalip 5eeb2d56d5 Added some tips to the contributor docs, namely about removing trailing whitespaces and about mentioning relevant ticket numbers in tests.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16688 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-26 02:43:33 +00:00
Jannis Leidel 127b7fdce8 Fixed #16469 -- Improved documentation of Django internals, including the new backport policy. Many thanks to Aymeric Augustin.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16548 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-07-19 13:16:09 +00:00
Jannis Leidel 8f7b5024b2 Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16547 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-07-19 09:00:24 +00:00
Ramiro Morales dff31de20a Fixed #16155 -- Removed Python 2.4 compatibility constructs from code and mentions from docs. Thanks Aymeric Augustin for the report and patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16349 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-06-09 20:01:28 +00:00
Timo Graham caefdc8246 Fixed #16090, #16091, #16114 - Typos in docs; thanks teraom.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16300 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-05-31 09:42:19 +00:00
Jannis Leidel 49f57a5d28 Fixed #15992 -- Added more references to settings. Thanks, aaugustin.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16290 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-05-29 17:41:04 +00:00
Jannis Leidel 407f62fd31 Fixed #15796 -- Restructured the contributing documentation and added note about newly added Trac abilities. Many thanks to Julien Phalip.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16284 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-05-27 10:49:47 +00:00