mirror of
https://github.com/Hopiu/wagtail.git
synced 2026-03-31 05:10:33 +00:00
Merge branch 'docs-contributing-updates'
This commit is contained in:
Karl Hobley
commit
4bb016cf75
8 changed files with 115 additions and 131 deletions
|
|
@ -1,30 +1,51 @@
|
|||
Developing Wagtail
|
||||
-----------------------
|
||||
Development
|
||||
-----------
|
||||
|
||||
Issues
|
||||
~~~~~~
|
||||
Using the demo site & Vagrant
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The easiest way to contribute to Wagtail is to tell us how to improve it! First, check to see if your bug or feature request has already been submitted at `github.com/torchbox/wagtail/issues <https://github.com/torchbox/wagtail/issues>`_. If it has, and you have some supporting information which may help us deal with it, comment on the existing issue. If not, please `create a new one <https://github.com/torchbox/wagtail/issues/new>`_, providing as much relevant context as possible. For example, if you're experiencing problems with installation, detail your environment and the steps you've already taken. If something isn't displaying correctly, tell us what browser you're using, and include a screenshot if possible.
|
||||
We recommend using the `Wagtail demo site <https://github.com/torchbox/wagtaildemo/>`_ which uses Vagrant, as a basis for developing Wagtail itself.
|
||||
|
||||
Pull requests
|
||||
~~~~~~~~~~~~~
|
||||
Install the wagtaildemo following the instructions in the `wagtaildemo README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_, then continue with the instructions below.
|
||||
|
||||
If you're a Python or Django developer, `fork <https://github.com/torchbox/wagtail/>`_ and get stuck in! Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_. We welcome all contributions, whether they solve problems which are specific to you or they address existing issues. If you're stuck for ideas, pick something from the `issue list <https://github.com/torchbox/wagtail/issues?state=open>`_, or email us directly on `hello@wagtail.io <mailto:hello@wagtail.io>`_ if you'd like us to suggest something!
|
||||
Clone a copy of `the Wagtail codebase <https://github.com/torchbox/wagtail>`_ alongside your demo site at the same level. So in the directory containing wagtaildemo, run::
|
||||
|
||||
Coding guidelines
|
||||
~~~~~~~~~~~~~~~~~
|
||||
git clone https://github.com/torchbox/wagtail.git
|
||||
|
||||
* PEP8. We ask that all Python contributions adhere to the `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_ style guide, apart from the restriction on line length (E501). The `pep8 tool <http://pep8.readthedocs.org/en/latest/>`_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``.
|
||||
* Python 2 and 3 compatibility. All contributions should support Python 2 and 3 and we recommend using the `six <https://pythonhosted.org/six/>`_ compatibility library (use the pip version installed as a dependency, not the version bundled with Django).
|
||||
* Tests. Wagtail has a suite of tests, which we are committed to improving and expanding. We run continuous integration at `travis-ci.org/torchbox/wagtail <https://travis-ci.org/torchbox/wagtail>`_ to ensure that no commits or pull requests introduce test failures. If your contributions add functionality to Wagtail, please include the additional tests to cover it; if your contributions alter existing functionality, please update the relevant tests accordingly.
|
||||
Enable the Vagrantfile included with the demo - this ensures you can edit the Wagtail codebase from outside Vagrant::
|
||||
|
||||
Running the unit tests
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
cd wagtaildemo
|
||||
cp Vagrantfile.local.example Vagrantfile.local
|
||||
|
||||
In order to run Wagtail's test suite, you will need to install some dependencies first. We recommend installing these into a virtual environment.
|
||||
If you clone Wagtail's codebase to somewhere other than one level above, edit ``Vagrantfile.local`` to specify the alternate path.
|
||||
|
||||
Lastly, we tell Django to use your freshly cloned Wagtail codebase as the source of Wagtail CMS, not the pip-installed version that came with wagtaildemo::
|
||||
|
||||
cp wagtaildemo/settings/local.py.example wagtaildemo/settings/local.py
|
||||
|
||||
Uncomment the lines from ``import sys`` onward, and edit the rest of ``local.py`` as appropriate.
|
||||
|
||||
If your VM is currently running, you'll then need to run ``vagrant halt`` followed by ``vagrant up`` for the changes to take effect.
|
||||
|
||||
|
||||
**Setting up the virtual environment**
|
||||
Development dependencies
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Developing Wagtail requires additional Python modules for testing and documentation.
|
||||
|
||||
The list of dependencies is in the Wagtail root directory in ``requirements-dev.txt`` and if you've used the Vagrant environment above, can be installed thus, from the Wagtail codebase root directory::
|
||||
|
||||
pip install -r requirements-dev.txt
|
||||
|
||||
|
||||
.. _testing:
|
||||
|
||||
Testing
|
||||
~~~~~~~
|
||||
|
||||
Wagtail has unit tests which should be run before submitting pull requests.
|
||||
|
||||
**Testing virtual environment** (skip this if working in Vagrant box)
|
||||
|
||||
If you are using Python 3.3 or above, run the following commands in your shell
|
||||
at the root of the Wagtail repo::
|
||||
|
|
@ -41,8 +62,7 @@ the first line above with:
|
|||
|
||||
**Running the tests**
|
||||
|
||||
With your virtual environment active, run the following command to run all the
|
||||
tests::
|
||||
From the root of the Wagtail codebase, run the following command to run all the tests::
|
||||
|
||||
python runtests.py
|
||||
|
||||
|
|
@ -81,35 +101,3 @@ If your Elasticsearch instance is located somewhere else, you can set the
|
|||
|
||||
If you no longer want Wagtail to test against Elasticsearch, uninstall the
|
||||
``elasticsearch`` package.
|
||||
|
||||
Styleguide
|
||||
~~~~~~~~~~
|
||||
|
||||
Developers working on the Wagtail UI or creating new UI components may wish to test their work against our Styleguide, which is provided as the contrib module "wagtailstyleguide".
|
||||
|
||||
To install the styleguide module on your site, add it to the list of ``INSTALLED_APPS`` in your settings:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
INSTALLED_APPS = (
|
||||
...
|
||||
'wagtail.contrib.wagtailstyleguide',
|
||||
...
|
||||
)
|
||||
|
||||
At present the styleguide is static: new UI components must be added to it manually, and there are no hooks into it for other modules to use. We hope to support hooks in the future.
|
||||
|
||||
The styleguide doesn't currently provide examples of all the core interface components; notably the Page, Document, Image and Snippet chooser interfaces are not currently represented.
|
||||
|
||||
|
||||
Translations
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Wagtail has internationalisation support so if you are fluent in a non-English language you can contribute by localising the interface.
|
||||
|
||||
Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.
|
||||
|
||||
Other contributions
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
We welcome contributions to all aspects of Wagtail. If you would like to improve the design of the user interface, or extend the documentation, please submit a pull request as above. If you're not familiar with Github or pull requests, `contact us directly <mailto:hello@wagtail.io>`_ and we'll work something out.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,37 @@
|
|||
Contributing to Wagtail
|
||||
=======================
|
||||
|
||||
Issues
|
||||
~~~~~~
|
||||
|
||||
The easiest way to contribute to Wagtail is to tell us how to improve it! First, check to see if your bug or feature request has already been submitted at `github.com/torchbox/wagtail/issues <https://github.com/torchbox/wagtail/issues>`_. If it has, and you have some supporting information which may help us deal with it, comment on the existing issue. If not, please `create a new one <https://github.com/torchbox/wagtail/issues/new>`_, providing as much relevant context as possible. For example, if you're experiencing problems with installation, detail your environment and the steps you've already taken. If something isn't displaying correctly, tell us what browser you're using, and include a screenshot if possible.
|
||||
|
||||
Pull requests
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
If you're a Python or Django developer, `fork <https://github.com/torchbox/wagtail/>`_ and get stuck in! Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_. We welcome all contributions, whether they solve problems which are specific to you or they address existing issues. If you're stuck for ideas, pick something from the `issue list <https://github.com/torchbox/wagtail/issues?state=open>`_, or email us directly on `hello@wagtail.io <mailto:hello@wagtail.io>`_ if you'd like us to suggest something!
|
||||
|
||||
|
||||
Translations
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Wagtail has internationalisation support so if you are fluent in a non-English language you can contribute by localising the interface.
|
||||
|
||||
Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.
|
||||
|
||||
|
||||
Other contributions
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
We welcome contributions to all aspects of Wagtail. If you would like to improve the design of the user interface, or extend the documentation, please submit a pull request as above. If you're not familiar with Github or pull requests, `contact us directly <mailto:hello@wagtail.io>`_ and we'll work something out.
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
developing
|
||||
styleguide
|
||||
python_guidelines
|
||||
css_guidelines
|
||||
javascript_guidelines
|
||||
|
|
|
|||
21
docs/contributing/python_guidelines.rst
Normal file
21
docs/contributing/python_guidelines.rst
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
Python coding guidelines
|
||||
========================
|
||||
|
||||
PEP8
|
||||
~~~~
|
||||
|
||||
We ask that all Python contributions adhere to the `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_ style guide, apart from the restriction on line length (E501). The `pep8 tool <http://pep8.readthedocs.org/en/latest/>`_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``.
|
||||
|
||||
|
||||
Python 2 and 3 compatibility
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
All contributions should support Python 2 and 3 and we recommend using the `six <https://pythonhosted.org/six/>`_ compatibility library (use the pip version installed as a dependency, not the version bundled with Django).
|
||||
|
||||
|
||||
Tests
|
||||
~~~~~
|
||||
|
||||
Wagtail has a suite of tests, which we are committed to improving and expanding. See :ref:`testing`.
|
||||
|
||||
We run continuous integration at `travis-ci.org/torchbox/wagtail <https://travis-ci.org/torchbox/wagtail>`_ to ensure that no commits or pull requests introduce test failures. If your contributions add functionality to Wagtail, please include the additional tests to cover it; if your contributions alter existing functionality, please update the relevant tests accordingly.
|
||||
18
docs/contributing/styleguide.rst
Normal file
18
docs/contributing/styleguide.rst
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
UI Styleguide
|
||||
=============
|
||||
|
||||
Developers working on the Wagtail UI or creating new UI components may wish to test their work against our Styleguide, which is provided as the contrib module "wagtailstyleguide".
|
||||
|
||||
To install the styleguide module on your site, add it to the list of ``INSTALLED_APPS`` in your settings:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
INSTALLED_APPS = (
|
||||
...
|
||||
'wagtail.contrib.wagtailstyleguide',
|
||||
...
|
||||
)
|
||||
|
||||
At present the styleguide is static: new UI components must be added to it manually, and there are no hooks into it for other modules to use. We hope to support hooks in the future.
|
||||
|
||||
The styleguide doesn't currently provide examples of all the core interface components; notably the Page, Document, Image and Snippet chooser interfaces are not currently represented.
|
||||
8
docs/getting_started/demo_site.rst
Normal file
8
docs/getting_started/demo_site.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
=========
|
||||
Demo site
|
||||
=========
|
||||
|
||||
|
||||
To create a new site on Wagtail we recommend the ``wagtail start`` command in :doc:`creating_your_project`, however a demo site exists containing example page types and models. We also recommend you use the demo site for testing during development of Wagtail itself.
|
||||
|
||||
The repo and installation instructions can be found here: `https://github.com/torchbox/wagtaildemo <https://github.com/torchbox/wagtaildemo>`_
|
||||
|
|
@ -5,7 +5,7 @@ Getting started
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
trying_wagtail
|
||||
installation
|
||||
creating_your_project
|
||||
using_vagrant
|
||||
demo_site
|
||||
|
|
|
|||
|
|
@ -1,78 +0,0 @@
|
|||
==============
|
||||
Trying Wagtail
|
||||
==============
|
||||
|
||||
|
||||
Wagtail demo
|
||||
============
|
||||
|
||||
We provide a demo site containing a set of standard templates and page types - if you're new to Wagtail, this is the best way to try it out and familiarise yourself with how Wagtail works from the point of view of an editor.
|
||||
|
||||
If you're happy to use Vagrant, and you just want to set up the Wagtail demo site, or any other pre-existing Wagtail site that ships with Vagrant support, you don't need to install Wagtail at all. Install `Vagrant <http://www.vagrantup.com/>`__ and `VirtualBox <https://www.virtualbox.org/>`__, and run::
|
||||
|
||||
git clone https://github.com/torchbox/wagtaildemo.git
|
||||
cd wagtaildemo
|
||||
vagrant up
|
||||
vagrant ssh
|
||||
|
||||
|
||||
Then, within the SSH session::
|
||||
|
||||
./manage.py createsuperuser
|
||||
./manage.py runserver 0.0.0.0:8000
|
||||
|
||||
|
||||
This will make the demo site available on your host machine at the URL http://localhost:8000/ - you can access the Wagtail admin interface at http://localhost:8000/admin/ . Further instructions can be found at :ref:`editor_manual`.
|
||||
|
||||
Once you’ve experimented with the demo site and are ready to build your own site, it's time to install Wagtail on your host machine. Even if you intend to do all further Wagtail work within Vagrant, installing the Wagtail package on your host machine will provide the ``wagtail start`` command that sets up the initial file structure for your project.
|
||||
|
||||
|
||||
One line install
|
||||
================
|
||||
|
||||
|
||||
Ubuntu
|
||||
------
|
||||
|
||||
If you have a fresh instance of Ubuntu 13.04 or later, you can install Wagtail,
|
||||
along with a demonstration site containing a set of standard templates and page
|
||||
types, in one step. As the root user::
|
||||
|
||||
curl -O https://raw.githubusercontent.com/torchbox/wagtail/master/scripts/install/ubuntu.sh; bash ubuntu.sh
|
||||
|
||||
This script installs all the dependencies for a production-ready Wagtail site,
|
||||
including PostgreSQL, Redis, Elasticsearch, Nginx and uWSGI. We
|
||||
recommend you check through the script before running it, and adapt it according
|
||||
to your deployment preferences. The canonical version is at
|
||||
`github.com/torchbox/wagtail/blob/master/scripts/install/ubuntu.sh
|
||||
<https://github.com/torchbox/wagtail/blob/master/scripts/install/ubuntu.sh>`_.
|
||||
|
||||
|
||||
Debian
|
||||
------
|
||||
|
||||
If you have a fresh instance of Debian 7, you can install Wagtail, along with a
|
||||
demonstration site containing a set of standard templates and page types, in one
|
||||
step. As the root user::
|
||||
|
||||
curl -O https://raw.githubusercontent.com/torchbox/wagtail/master/scripts/install/debian.sh; bash debian.sh
|
||||
|
||||
This script installs all the dependencies for a production-ready Wagtail site,
|
||||
including PostgreSQL, Redis, Elasticsearch, Nginx and uWSGI. We
|
||||
recommend you check through the script before running it, and adapt it according
|
||||
to your deployment preferences. The canonical version is at
|
||||
`github.com/torchbox/wagtail/blob/master/scripts/install/debian.sh
|
||||
<https://github.com/torchbox/wagtail/blob/master/scripts/install/debian.sh>`_.
|
||||
|
||||
|
||||
Docker
|
||||
======
|
||||
|
||||
`@oyvindsk <https://github.com/oyvindsk>`_ has built a Dockerfile for the Wagtail demo. Simply run::
|
||||
|
||||
docker run -p 8000:8000 -d oyvindsk/wagtail-demo
|
||||
|
||||
then access the site at http://your-ip:8000 and the admin
|
||||
interface at http://your-ip:8000/admin using admin / test.
|
||||
|
||||
See https://index.docker.io/u/oyvindsk/wagtail-demo/ for more details.
|
||||
|
|
@ -8,7 +8,7 @@ Below are some useful links to help you get started with Wagtail.
|
|||
|
||||
* **First steps**
|
||||
|
||||
* :doc:`getting_started/trying_wagtail`
|
||||
* :doc:`getting_started/demo_site`
|
||||
* :doc:`getting_started/installation`
|
||||
* :doc:`getting_started/creating_your_project`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue