0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
Commit Graph

103 Commits

Author SHA1 Message Date
Daniel Chimeno
f70226c845 add way of autocompile documentation 2017-02-20 20:24:17 +00:00
Janneke Janssen
493a30bcf9 Add nvmrc to the project and updated developing docs 2017-02-20 11:14:33 +01:00
David Ray
49b78dd8a7 Removing errant words in sample path/to/wagtail 2017-02-03 20:41:08 +00:00
Thibaud Colas
c34f2eba0f Update contribution documentation for core team members (#3318)
* Update issue tracking docs, re. contributor workflow discussions

* Update docs regarding the PR review & merge process

* Update PR docs with suggestions re. contributor workflow
2017-02-03 09:46:15 +00:00
Daniel Chimeno
b61f688347 Improve docs testing (#3308)
* add information about running only some testcases
2017-01-28 01:02:44 +00:00
Matt Westcott
0f94222689 Specify version 4.x, 5.x or 6.x of Node
Gulp 3.x is currently incompatible with Node 7: https://github.com/gulpjs/gulp/issues/1843

Fixes #3253
2017-01-03 16:47:32 +00:00
Matt Westcott
7288a96950 Point people to Stack Overflow for support queries in preference to the Google group (#3255)
We plan to put additional resources into support on Stack Overflow, based on feedback at https://twitter.com/WagtailCMS/status/801384753589080064
2017-01-03 16:02:24 +00:00
Matt Westcott
6f834c9a9b Update links to github.com/torchbox to point to github.com/wagtail 2016-12-15 11:49:49 +00:00
Tim Heap
6ba34636cb Fix whitespace errors in docs
Trimmed trailing whitespace, convert tabs to 4 spaces, add preference
for spaces to `.editorconfig`.
2016-11-28 13:41:35 +00:00
Tim Heap
254e675634 Use .. code-block:: console for all shell commands
This is the correct lexer for interactive console sessions, according to
<http://pygments.org/docs/lexers/>. This does require command lines to
be prefixed with `$`, otherwise they are interpreted as the output of a
command. It highlights the command nicely, including environment
variables, strings, and comments.
2016-11-28 13:41:35 +00:00
Matt Westcott
d9c27f0325 Tell developers to use the bundled version of six (we don't install it as a dependency any more) 2016-11-09 10:35:12 +00:00
Tom Dyson
d68c015658 Specify Github merge option for minor doc fixes (#3144) 2016-11-08 09:57:15 +00:00
Matt Westcott
7545ed3675 We don't have t-shirts any more :-( 2016-10-27 20:55:19 +01:00
Ducky
7922f1abeb restructured and added to contribution guide
As a new contributor I found some of the information for contributing hard to
find easily. I think this restructure should fix that, by bringing relevant
menus under their headings and adding an additional heading for 'more
information' instead of just 'other contributions'.
2016-10-27 20:50:28 +01:00
Mikalai Radchuk
ae33f7192d Adds "Supported versions of Django"
Adds "Supported versions of Django" section
into "Wagtail's release process" document.
2016-09-21 18:50:44 +01:00
Mikalai Radchuk
d3568df5b3 Adds docs about release process 2016-09-21 18:50:21 +01:00
Matt Westcott
86e60fd4a3 Mention where to access the styleguide - fixes #3009 2016-09-19 13:49:52 +01:00
Matt Westcott
7d8c7ec758 Add 'issue tracking' docs (#2794) 2016-07-19 16:17:54 +01:00
Matt Westcott
64c7a6367a Document isort and 'make lint' in Python coding guidelines 2016-06-23 16:31:44 +01:00
Robert Rollins
11793f88c5 Changed indentation on all code samples to 4 spaces.
Most of the samples were already 4-space indented, but a few were using 2-space,
which is both inconsistent and, when it happened with Python code samples,
incompatible with PEP8.
2016-04-28 10:57:22 +01:00
Tim Heap
4b46ff341d Add docs on making Wagtail compatible with multiple Django versions 2016-03-27 07:15:56 +02:00
Tim Heap
84432fbfd6 Add docs on how to build docs
I put some docs in your docs on building docs, so now I can build docs
about my docs from my docs.
2016-03-11 17:24:38 +00:00
Matt Westcott
dadef2a017 Recommend the -U switch when running pip install -e .
This more reliably ensures that the user has up-to-date dependencies (e.g. without it, a
beta version of a package like Willow or modelcluster won't get installed if the user has
a stable version already installed)
2016-03-07 18:31:29 +00:00
Mikalai Radchuk
fb50eb0d7e Fixes wrong links format in CSS coding guidelines 2016-03-07 20:38:47 +03:00
Mikalai Radchuk
660278d417 Fixes typos in docs for #2201 and #2302 2016-03-07 09:47:40 +00:00
Tim Heap
74986f7d4d Add docs on committing code
Inspiration and flow from Django's
`internals/contributing/committing-code` docs
2016-03-03 02:00:37 +02:00
Matt Westcott
7ed53087aa Update node.js version requirements 2016-02-29 15:55:02 +00:00
Charlie Choiniere
ae2006ccf1 Moved all dev dependencies into setup.py
* Removed requirements-dev.txt
 * Added dependencies to setup.py using the extras_require option
 * Updated the documentation to use pip instead of setup.py develop
 * Updated .drone.yml to reflect updated installation
2016-02-05 14:44:51 +00:00
Karl Hobley
06cba807df Merge pull request #1914 from kaedroho/runtests-args
Add --postgres and --elasticsearch arguments to runtests.py
2015-11-30 12:26:16 +00:00
Dave Cranwell
29753ecb0d updated css guidelines. removed duplicate linting block 2015-11-24 00:05:31 +00:00
Dave Cranwell
fc980bd103 updated npm packages. ongoing linting of scss files 2015-11-23 21:39:54 +00:00
Karl Hobley
3b2e54bc7c Make elasticsearch-py a dev requirement
The Elasticsearch tests now depend on an environment variable being set so we can safely install elasticsearch-py without Wagtail automatically assuming Elasticsearch is installed and running the tests.

This makes developer setup slightly easier, but also opens up the possibility for running some of the ES tests that don't depend on a running ES instance.
2015-11-19 16:23:47 +00:00
Karl Hobley
7459329d93 Added --elasticsearch argument to runtests.py 2015-11-09 12:13:07 +00:00
Karl Hobley
126761db51 Added --postgres argument to runtests.py
Makes running the tests against PostgreSQL a bit easier
2015-11-09 12:04:50 +00:00
Tim Heap
3d494fb24b Move wagtailsettings into contrib module
The `wagtailsettings` module is useful enough that it should be included
in the Wagtail contrib section, to make it available to all Wagtail
developers.

All the code has been given a once-over to make sure it is nice and
polished before being copied in. As such, this is not a direct copy of
the `wagtailsettings` module. It should be backwards compatible though,
excepting the new location.

It has been moved to `wagtail.contrib.settings`, following the naming
scheme set out in #1504.

Documentation has been concatenated in to a single page, and added to
the contrib reference section.
2015-10-21 16:39:09 +11:00
Tim Heap
bc6b5a8a6c Normalise all code blocks in the docs
All `.. code::` instances have been changed to use `.. code-block::`,
and have been properly formatted. The syntax names have been normalised,
so all django templates use the `html+django` syntax, shell commands use
`sh`, and plain text uses `text`.
2015-10-05 16:55:58 +01:00
Matt Westcott
1afc5ba0f1 Transferred vagrant-wagtail-develop repo to torchbox 2015-09-30 16:24:42 +01:00
Matt Westcott
377db9e878 Rewrite developer setup docs
* State the requirement for Node.js up-front (since it's required by everyone, not just front-end devs)
* Point to vagrant-wagtail-develop instead of making people set up a Vagrant instance manually
* No need to fiddle with python paths via local.py - 'setup.py develop' handles that
* Skip instructions for virtualenvs (anyone who decides against the Vagrant route is expected to know how to use them)
2015-09-30 15:54:08 +01:00
Matt Westcott
b62faf73ba Clarify 'the directory containing wagtaildemo' - fixes #1651 2015-09-01 10:13:16 +01:00
Karl Hobley
23969890cb Merge remote-tracking branch 'takeflight/refactor/remove-libsass' 2015-05-19 17:25:52 +01:00
Dave Cranwell
5a1f4de23c replaced bullets with headings in python guidelines 2015-05-18 09:46:38 +01:00
Dave Cranwell
2ab94a0022 made difference clearer between coding style and styleguide 2015-05-18 09:46:38 +01:00
Dave Cranwell
66a901c48c removed duplicated/out-of-date information about getting started using the demo site. this is now only in the actual wagtaildemo repo 2015-05-18 09:46:38 +01:00
Dave Cranwell
ef4d9b00c5 moved github issues/pr info into index page, leaving the developing page more about actual development, not housekeeping 2015-05-18 09:46:38 +01:00
Dave Cranwell
bf6607de54 moved styleguide to own page. renamed trying wagtail to demo site 2015-05-18 09:46:38 +01:00
Karl Hobley
16294c2fd2 Fix reference to javascript_guidelines 2015-05-14 10:26:03 +01:00
Tim Heap
676799da45 Add docs on compiling the static admin assets 2015-05-05 22:23:05 +10:00
Tim Heap
136d97dca2 Add instructions on compiling SCSS files to docs 2015-05-01 08:53:04 +10:00
Josh Barr
d83ef58ecb added JS documentation to the contributing section 2015-04-27 23:05:36 +12:00
Dan Braghis
4adb3f2dc4 Change translation wording to strongly point to Transifex 2015-04-22 10:36:00 +01:00
Dan Braghis
d725bb0390 Update RTD links and add Transifex as preferred translation option 2015-04-22 10:26:21 +01:00
Karl Hobley
59bf899a6a Docs: Fix title underline 2015-04-21 16:05:37 +01:00
Josh Barr
b7ef25d8e0 created contrib section in docs, made amends to css styleguide 2015-04-18 08:34:54 +12:00