From 3b691bc758172523bab48e39ef222342f2a24811 Mon Sep 17 00:00:00 2001 From: Tom Dyson Date: Tue, 18 Feb 2014 17:45:31 +0000 Subject: [PATCH] First pass at Sphinx docs --- .gitignore | 1 + docs/Makefile | 177 ++++++++++++++++++++++++ docs/building_your_site.rst | 6 + docs/conf.py | 259 ++++++++++++++++++++++++++++++++++++ docs/contributing.rst | 23 ++++ docs/deploying.rst | 21 +++ docs/gettingstarted.rst | 74 +++++++++++ docs/index.rst | 15 +++ docs/performance.rst | 49 +++++++ docs/support.rst | 17 +++ docs/wagtail_search.rst | 15 +++ 11 files changed, 657 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/building_your_site.rst create mode 100644 docs/conf.py create mode 100644 docs/contributing.rst create mode 100644 docs/deploying.rst create mode 100644 docs/gettingstarted.rst create mode 100644 docs/index.rst create mode 100644 docs/performance.rst create mode 100644 docs/support.rst create mode 100644 docs/wagtail_search.rst diff --git a/.gitignore b/.gitignore index 332c4bdb0..890183617 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ /dist/ /MANIFEST /wagtail.egg-info/ +/docs/_build/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..5b4eb026a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Wagtail.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Wagtail.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Wagtail" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Wagtail" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/building_your_site.rst b/docs/building_your_site.rst new file mode 100644 index 000000000..b506f67f2 --- /dev/null +++ b/docs/building_your_site.rst @@ -0,0 +1,6 @@ +Building your site +================== + +Serafeim Papastefanos has written a comprehensive tutorial on creating a site from scratch in Wagtail; for the time being, this is our recommended resource: + +`spapas.github.io/2014/02/13/wagtail-tutorial/ `_ \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..9a6eb1e0e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,259 @@ +# -*- coding: utf-8 -*- +# +# Wagtail documentation build configuration file, created by +# sphinx-quickstart on Tue Jan 14 17:38:55 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import sphinx_rtd_theme + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Wagtail Documentation' +copyright = u'2014, Torchbox' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "sphinx_rtd_theme" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Wagtaildoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'Wagtail.tex', u'Wagtail Documentation', + u'Torchbox', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'wagtail', u'Wagtail Documentation', + [u'Torchbox'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Wagtail', u'Wagtail Documentation', + u'Torchbox', 'Wagtail', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 000000000..a75fd9cb9 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,23 @@ +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 `_. 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 `_, 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 `_ and get stuck in! Send us a useful pull request and we'll post you a `t-shirt `_. 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 `_, or email us directly on `hello@wagtail.io `_ if you'd like us to suggest something! + +Coding guidelines +~~~~~~~~~~~~~~~~~ + +* PEP8. We ask that all Python contributions adhere to the `PEP8 `_ style guide, apart from the restriction on line length (E501). The `pep8 tool `_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``. +* 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 `_ 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. + +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 `_ and we'll work something out. diff --git a/docs/deploying.rst b/docs/deploying.rst new file mode 100644 index 000000000..5ca7c67df --- /dev/null +++ b/docs/deploying.rst @@ -0,0 +1,21 @@ +Deploying Wagtail +----------------- + +On your server +~~~~~~~~~~~~~~ + +Wagtail is straightforward to deploy on modern Linux-based distributions, but see the section on :doc:`performance ` for the non-Python services we recommend. If you are running Debian or Ubuntu, this installation script for our Vagrant box may be useful: + +`github.com/torchbox/wagtaildemo/blob/master/etc/install/install.sh `_ + +Our current preferences are for Nginx, Gunicorn and supervisor on Debian, but Wagtail should run with any of the combinations detailed in Django's `deployment documentation `_. + +On Gondor +~~~~~~~~~ + +`Gondor `_ specialise in Python hosting. They provide Redis and Elasticsearch, which are two of the services we recommend for high-performance production sites. Gondor have written a comprehensive tutorial on running your Wagtail site on their platform, at `gondor.io/blog/2014/02/14/how-run-wagtail-cms-gondor/ `_. + +On other PAASs and IAASs +~~~~~~~~~~~~~~~~~~~~~~~~ + +We know of Wagtail sites running on `Heroku `_, Digital Ocean and elsewhere. If you have successfully installed Wagtail on your platform or infrastructure, please :doc:`contribute ` your notes to this documentation! \ No newline at end of file diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst new file mode 100644 index 000000000..4d716dc32 --- /dev/null +++ b/docs/gettingstarted.rst @@ -0,0 +1,74 @@ +Getting Started +--------------- + +Using Vagrant +~~~~~~~~~~~~~ + + We provide a Vagrant box which includes all the dependencies for a fully-fledged Wagtail environment, bundled with a demonstration site containing a set of standard templates and page types. If you have a good internet connection we recommend the following steps, which will download the 650MB Vagrant box and make a running Wagtail instance available as the basis for your new site: + +- Install `Vagrant `_ 1.1+ +- Clone the demonstration site, create the Vagrant box and initialise Wagtail:: + + git clone git@github.com:torchbox/wagtaildemo.git + cd wagtaildemo + vagrant up + vagrant ssh + # within the SSH session + ./manage.py createsuperuser + ./manage.py update_index + ./manage.py runserver 0.0.0.0:8000 + +- This will make the app accessible on the host machine as `localhost:8111 `_ - you can access the Wagtail admin interface at `localhost:8111/admin `_. The codebase is located on the host machine, exported to the VM as a shared folder; code editing and Git operations will generally be done on the host. + +Without Vagrant +~~~~~~~~~~~~~~~ + +For production, or if you prefer not to use Vagrant, use the following steps to install Wagtail: + +Required dependencies +===================== + +- `npm`_ +- `CoffeeScript`_ +- `Less`_ +- `pip`_ + +Optional dependencies +===================== + +- `PostgreSQL`_ +- `Elasticsearch`_ + +Installation +============ + +With PostgreSQL running (and configured to allow you to connect as the +'postgres' user - if not, you'll need to adjust the ``createdb`` line +and the database settings in wagtaildemo/settings/base.py accordingly), +run the following commands:: + + git clone https://github.com/torchbox/wagtaildemo.git + cd wagtaildemo + pip install -r requirements/dev.txt + createdb -Upostgres wagtaildemo + ./manage.py syncdb + ./manage.py migrate + ./manage.py createsuperuser + ./manage.py runserver + +SQLite support +============== + +SQLite is supported as an alternative to PostgreSQL - update the DATABASES setting +in wagtaildemo/settings/base.py to use 'django.db.backends.sqlite3', as you would +with a regular Django project. + +.. _Wagtail: http://wagtail.io +.. _VirtualBox: https://www.virtualbox.org/ +.. _the Wagtail codebase: https://github.com/torchbox/wagtail +.. _PostgreSQL: http://www.postgresql.org +.. _Elasticsearch: http://www.elasticsearch.org +.. _npm: https://npmjs.org/ +.. _CoffeeScript: http://coffeescript.org/ +.. _Less: http://lesscss.org/ +.. _Pip: https://github.com/pypa/pip diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..937682791 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +Welcome to Wagtail's documentation +================================== + +Wagtail is a modern, flexible CMS, built on Django. + +.. toctree:: + :maxdepth: 2 + + gettingstarted + building_your_site + wagtail_search + deploying + performance + contributing + support diff --git a/docs/performance.rst b/docs/performance.rst new file mode 100644 index 000000000..cfbcea59e --- /dev/null +++ b/docs/performance.rst @@ -0,0 +1,49 @@ +Performance +=========== + +Wagtail is designed for speed, both in the editor interface and on the front-end, but if you want even better performance or you need to handle very high volumes of traffic, here are some tips on eeking out the most from your installation. + +Editor interface +~~~~~~~~~~~~~~~~ + +We have tried to minimise external dependencies for a working installation of Wagtail, in order to make it as simple as possible to get going. However, a number of default settings can be configured for better performance: + +Cache +----- + +We recommend `Redis `_ as a fast, persistent cache. Install Redis through package manager and enable it as a cache backend:: + + CACHES = { + 'default': { + 'BACKEND': 'redis_cache.cache.RedisCache', + 'LOCATION': '127.0.0.1:6379', + 'OPTIONS': { + 'CLIENT_CLASS': 'redis_cache.client.DefaultClient', + } + } + } + +Without a persistent cache, Wagtail will recreate all compressable assets at each server start, e.g. when any files change under ```./manage.py runserver```. + +Search +------ + +Wagtail has strong support for `Elasticsearch `_ - both in the editor interface and for users of your site - but can fall back to a database search if Elasticsearch isn't present. Elasticsearch is faster and more powerful than the Django ORM for text search, so we recommend installing it or using a hosted service like `Searchly `_. + +Database +-------- + +Wagtail is tested on SQLite, and should work on other Django-supported database backends, but we recommend PostgreSQL for production use. + +Asset compression +----------------- + +The Wagtail editor UI is based on `Less `_. We aim to provide support for pure-Python Less compilation, to minimise installation requirements, but the official node.js-based compiler is significantly faster. We recommend installing this in production, and you may also prefer to use it to speed up your development environment. + +Public users +~~~~~~~~~~~~ + +Caching proxy +------------- + +To support high volumes of traffic with excellent response times, we recommend a caching proxy. Both `Varnish `_ and `Squid `_ have been tested in production. Hosted proxies like `Cloudflare `_ should also work well. \ No newline at end of file diff --git a/docs/support.rst b/docs/support.rst new file mode 100644 index 000000000..2ea5dff3e --- /dev/null +++ b/docs/support.rst @@ -0,0 +1,17 @@ +Support +------- + +Mailing list +~~~~~~~~~~~~ + +If you have general questions about Wagtail, or you're looking for help on how to do something that these documents don't cover, join the mailing list at `groups.google.com/d/forum/wagtail `_. + +Issues +~~~~~~ + +If you think you've found a bug in Wagtail, or you'd like to suggest a new feature, please check the current list at `github.com/torchbox/wagtail/issues `_. If your bug or suggestion isn't there, raise a new issue, providing as much relevant context as possible. + +Torchbox +~~~~~~~~ + +Finally, if you have a query which isn't relevant for either of the above forums, feel free to contact the Wagtail team at Torchbox directly, on `hello@wagtail.io `_. \ No newline at end of file diff --git a/docs/wagtail_search.rst b/docs/wagtail_search.rst new file mode 100644 index 000000000..1bef60724 --- /dev/null +++ b/docs/wagtail_search.rst @@ -0,0 +1,15 @@ +Search +====== + +Wagtail can degrade to a database-backed text search, but we strongly recommend `Elasticsearch`_. If you prefer not to run an Elasticsearch server in development or production, there are many hosted services available, including `Searchly`_, who offer a free account suitable for testing and development. To use Searchly: + +- Sign up for an account at `dashboard.searchly.com/users/sign\_up`_ +- Use your Searchly dashboard to create a new index, e.g. 'wagtaildemo' +- Note the connection URL from your Searchly dashboard +- Update ``WAGTAILSEARCH_ES_URLS`` and ``WAGTAILSEARCH_ES_INDEX`` in + your local settings +- Run ``./manage.py update_index`` + +.. _Elasticsearch: http://www.elasticsearch.org/ +.. _Searchly: http://www.searchly.com/ +.. _dashboard.searchly.com/users/sign\_up: https://dashboard.searchly.com/users/sign_up \ No newline at end of file