kopia lustrzana https://github.com/wagtail/wagtail
Update links in documentation. (#5689)
Use HTTPS links instead of non-secure HTTP links wherever possible in documentation.pull/5698/head
rodzic
985e5b2274
commit
229103ff2e
|
@ -10,12 +10,12 @@ documentation, translations or just feature requests.
|
|||
The [issue tracker](https://github.com/wagtail/wagtail/issues) is
|
||||
the preferred channel for [bug reports](#bugs), [features requests](#features)
|
||||
and [submitting pull requests](#pull-requests). Please don't use the issue tracker
|
||||
for support - use [the 'wagtail' tag on Stack Overflow](http://stackoverflow.com/questions/tagged/wagtail) (preferred) or our [Wagtail support group](https://groups.google.com/forum/#!forum/wagtail).
|
||||
for support - use [the 'wagtail' tag on Stack Overflow](https://stackoverflow.com/questions/tagged/wagtail) (preferred) or our [Wagtail support group](https://groups.google.com/forum/#!forum/wagtail).
|
||||
|
||||
## New code
|
||||
|
||||
Please review the
|
||||
[contributing guidelines](http://docs.wagtail.io/en/latest/contributing/index.html).
|
||||
[contributing guidelines](https://docs.wagtail.io/en/latest/contributing/index.html).
|
||||
You might like to start by checking issues with the
|
||||
[good first issue](https://github.com/wagtail/wagtail/labels/good%20first%20issue) label.
|
||||
|
||||
|
|
|
@ -30,4 +30,4 @@ Any other relevant information. For example, why do you consider this a bug and
|
|||
* Python version: Run `python --version`.
|
||||
* Django version: Look in your requirements.txt, or run `pip show django | grep Version`.
|
||||
* Wagtail version: Look at the bottom of the Settings menu in the Wagtail admin, or run `pip show wagtail | grep Version:`.
|
||||
* Browser version: You can use http://www.whatsmybrowser.org/ to find this out.
|
||||
* Browser version: You can use https://www.whatsmybrowser.org/ to find this out.
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
Thanks for contributing to Wagtail! 🎉
|
||||
|
||||
Before submitting, please review the contributor guidelines <http://docs.wagtail.io/en/latest/contributing/index.html> and check the following:
|
||||
Before submitting, please review the contributor guidelines <https://docs.wagtail.io/en/latest/contributing/index.html> and check the following:
|
||||
|
||||
* Do the tests still pass? (http://docs.wagtail.io/en/latest/contributing/developing.html#testing)
|
||||
* Do the tests still pass? (https://docs.wagtail.io/en/latest/contributing/developing.html#testing)
|
||||
* Does the code comply with the style guide? (Run `make lint` from the Wagtail root)
|
||||
* For Python changes: Have you added tests to cover the new/fixed behaviour?
|
||||
* For front-end changes: Did you test on all of Wagtail’s supported browsers? **Please list the exact versions you tested**.
|
||||
|
|
|
@ -68,7 +68,7 @@ members of the project's leadership.
|
|||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
available at [https://www.contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
[homepage]: https://www.contributor-covenant.org/
|
||||
[version]: https://www.contributor-covenant.org/version/1/4/
|
||||
|
|
12
README.md
12
README.md
|
@ -40,15 +40,15 @@ python manage.py createsuperuser
|
|||
python manage.py runserver
|
||||
```
|
||||
|
||||
For detailed installation and setup docs, see [docs.wagtail.io](http://docs.wagtail.io/).
|
||||
For detailed installation and setup docs, see [docs.wagtail.io](https://docs.wagtail.io/).
|
||||
|
||||
### Who’s using it?
|
||||
|
||||
Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to [madewithwagtail.org](http://madewithwagtail.org).
|
||||
Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to [madewithwagtail.org](https://madewithwagtail.org).
|
||||
|
||||
### Documentation
|
||||
|
||||
[docs.wagtail.io](http://docs.wagtail.io/) is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
|
||||
[docs.wagtail.io](https://docs.wagtail.io/) is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
|
||||
|
||||
### Compatibility
|
||||
|
||||
|
@ -64,7 +64,7 @@ Previous versions of Wagtail (1.13 and earlier) additionally supported Python 2.
|
|||
|
||||
### Community Support
|
||||
|
||||
There is an active community of Wagtail users and developers responding to questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/wagtail). When posting questions, please read Stack Overflow's advice on [how to ask questions](http://stackoverflow.com/help/how-to-ask) and remember to tag your question "wagtail".
|
||||
There is an active community of Wagtail users and developers responding to questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/wagtail). When posting questions, please read Stack Overflow's advice on [how to ask questions](https://stackoverflow.com/help/how-to-ask) and remember to tag your question "wagtail".
|
||||
|
||||
For topics and discussions that do not fit Stack Overflow's question and answer format, we have a [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack) and a [Wagtail Support mailing list](https://groups.google.com/forum/#!forum/wagtail). Please respect the time and effort of volunteers by not asking the same question in multiple places.
|
||||
|
||||
|
@ -92,7 +92,7 @@ To try out the latest features before a release, we also create builds from mast
|
|||
|
||||
If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).
|
||||
|
||||
You might like to start by reviewing the [contributing guidelines](http://docs.wagtail.io/en/latest/contributing/index.html) and checking issues with the [good first issue](https://github.com/wagtail/wagtail/labels/good%20first%20issue) label.
|
||||
You might like to start by reviewing the [contributing guidelines](https://docs.wagtail.io/en/latest/contributing/index.html) and checking issues with the [good first issue](https://github.com/wagtail/wagtail/labels/good%20first%20issue) label.
|
||||
|
||||
We also welcome translations for Wagtail's interface. Translation work should be submitted through [Transifex](https://www.transifex.com/projects/p/wagtail/).
|
||||
|
||||
|
@ -113,5 +113,5 @@ We thank the following organisations for their services used in Wagtail's develo
|
|||
[](https://travis-ci.org/wagtail/wagtail)
|
||||
[](https://opensource.org/licenses/BSD-3-Clause)
|
||||
[](https://pypi.python.org/pypi/wagtail/)
|
||||
[](http://codecov.io/github/wagtail/wagtail?branch=master)
|
||||
[](https://codecov.io/github/wagtail/wagtail?branch=master)
|
||||
[](https://wagtail-slack.now.sh)
|
||||
|
|
|
@ -7,11 +7,11 @@ The following organisations and individuals supported the [Wagtail's First Hatch
|
|||
- [Ambient Innovation](https://ambient-innovation.com/)
|
||||
- [Shenberger Technology](http://shenbergertech.com/)
|
||||
- [Type/Code](https://typecode.com/)
|
||||
- [SharperTool](http://sharpertool.com/)
|
||||
- [SharperTool](https://sharpertool.com/)
|
||||
- [Overcast Software](https://www.overcast.io/)
|
||||
- [Octave](https://octave.nz/)
|
||||
- [Taywa](https://www.taywa.ch/)
|
||||
- [Rock Kitchen Harris](https://www.rkh.co.uk/)
|
||||
- [The Motley Fool](http://www.fool.com/)
|
||||
- [The Motley Fool](https://www.fool.com/)
|
||||
- [R Strother Scott](https://twitter.com/rstrotherscott)
|
||||
- [Beyond Media](http://beyond.works/)
|
||||
- [Beyond Media](https://www.beyond.works/)
|
||||
|
|
|
@ -9,7 +9,7 @@ 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/)
|
||||
$(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 https://www.sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Wagtail docs
|
||||
|
||||
These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):
|
||||
These are Sphinx docs, automatically built at https://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):
|
||||
|
||||
pip install -e .[testing,docs]
|
||||
|
||||
|
|
|
@ -191,8 +191,8 @@ This adds two fields to the API (other fields omitted for brevity):
|
|||
"published_date_display": "Thursday 06 April 2017"
|
||||
}
|
||||
|
||||
.. _Serialisers: http://www.django-rest-framework.org/api-guide/fields/
|
||||
.. _source: http://www.django-rest-framework.org/api-guide/fields/#source
|
||||
.. _Serialisers: https://www.django-rest-framework.org/api-guide/fields/
|
||||
.. _source: https://www.django-rest-framework.org/api-guide/fields/#source
|
||||
|
||||
Images in the API
|
||||
-----------------
|
||||
|
|
|
@ -73,6 +73,6 @@ The following code will add the ``<blockquote>`` element to the whitelist whenev
|
|||
WhitelistRule('blockquote', allow_without_attributes),
|
||||
])
|
||||
|
||||
``WhitelistRule`` is passed the element name, and a callable which will perform some kind of manipulation of the element whenever it is encountered. This callable receives the element as a `BeautifulSoup <http://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_ Tag object.
|
||||
``WhitelistRule`` is passed the element name, and a callable which will perform some kind of manipulation of the element whenever it is encountered. This callable receives the element as a `BeautifulSoup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_ Tag object.
|
||||
|
||||
The ``wagtail.core.whitelist`` module provides a few helper functions to assist in defining these handlers: ``allow_without_attributes``, a handler which preserves the element but strips out all of its attributes, and ``attribute_rule`` which accepts a dict specifying how to handle each attribute, and returns a handler function. This dict will map attribute names to either True (indicating that the attribute should be kept), False (indicating that it should be dropped), or a callable (which takes the initial attribute value and returns either a final value for the attribute, or None to drop the attribute).
|
||||
|
|
|
@ -160,7 +160,7 @@ or to add custom validation logic for your models:
|
|||
|
||||
from django import forms
|
||||
from django.db import models
|
||||
import geocoder # not in Wagtail, for example only - http://geocoder.readthedocs.io/
|
||||
import geocoder # not in Wagtail, for example only - https://geocoder.readthedocs.io/
|
||||
from wagtail.admin.edit_handlers import FieldPanel
|
||||
from wagtail.admin.forms import WagtailAdminPageForm
|
||||
from wagtail.core.models import Page
|
||||
|
|
|
@ -14,7 +14,7 @@ On Divio Cloud
|
|||
`Divio Cloud <https://divio.com/>`_ is a Dockerised cloud hosting platform for Python/Django that allows you to launch and deploy Wagtail projects in minutes. With a free account, you can create a Wagtail project. Choose from a:
|
||||
|
||||
* `site based on the Wagtail Bakery project <https://divio.com/wagtail>`_, or
|
||||
* `brand new Wagtail project <https://control.divio.com/control/project/create>`_ (see the `how to get started notes <http://support.divio.com/project-types/wagtail/get-started-with-wagtail-on-divio-cloud>`_).
|
||||
* `brand new Wagtail project <https://control.divio.com/control/project/create>`_ (see the `how to get started notes <https://support.divio.com/project-types/wagtail/get-started-with-wagtail-on-divio-cloud>`_).
|
||||
|
||||
Divio Cloud also hosts a `live Wagtail Bakery demo <https://divio.com/wagtail>`_ (no account required).
|
||||
|
||||
|
@ -26,7 +26,7 @@ On PythonAnywhere
|
|||
On other PAASs and IAASs
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
We know of Wagtail sites running on `Heroku <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_, Digital Ocean and elsewhere. If you have successfully installed Wagtail on your platform or infrastructure, please :doc:`contribute </contributing/index>` your notes to this documentation!
|
||||
We know of Wagtail sites running on `Heroku <https://spapas.github.io/2014/02/13/wagtail-tutorial/>`_, Digital Ocean and elsewhere. If you have successfully installed Wagtail on your platform or infrastructure, please :doc:`contribute </contributing/index>` your notes to this documentation!
|
||||
|
||||
Deployment tips
|
||||
~~~~~~~~~~~~~~~
|
||||
|
|
|
@ -13,7 +13,7 @@ We have tried to minimise external dependencies for a working installation of Wa
|
|||
Cache
|
||||
-----
|
||||
|
||||
We recommend `Redis <http://redis.io/>`_ as a fast, persistent cache. Install Redis through your package manager (on Debian or Ubuntu: ``sudo apt-get install redis-server``), add ``django-redis`` to your ``requirements.txt``, and enable it as a cache backend:
|
||||
We recommend `Redis <https://redis.io/>`_ as a fast, persistent cache. Install Redis through your package manager (on Debian or Ubuntu: ``sudo apt-get install redis-server``), add ``django-redis`` to your ``requirements.txt``, and enable it as a cache backend:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
|
@ -33,7 +33,7 @@ We recommend `Redis <http://redis.io/>`_ as a fast, persistent cache. Install Re
|
|||
Search
|
||||
------
|
||||
|
||||
Wagtail has strong support for `Elasticsearch <http://www.elasticsearch.org/>`_ - 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 <http://www.searchly.com/>`_.
|
||||
Wagtail has strong support for `Elasticsearch <https://www.elastic.co>`_ - 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 <http://www.searchly.com/>`_.
|
||||
|
||||
For details on configuring Wagtail for Elasticsearch, see :ref:`wagtailsearch_backends_elasticsearch`.
|
||||
|
||||
|
@ -75,6 +75,6 @@ Public users
|
|||
Caching proxy
|
||||
-------------
|
||||
|
||||
To support high volumes of traffic with excellent response times, we recommend a caching proxy. Both `Varnish <http://www.varnish-cache.org/>`_ and `Squid <http://www.squid-cache.org/>`_ have been tested in production. Hosted proxies like `Cloudflare <https://www.cloudflare.com/>`_ should also work well.
|
||||
To support high volumes of traffic with excellent response times, we recommend a caching proxy. Both `Varnish <https://varnish-cache.org/>`_ and `Squid <http://www.squid-cache.org/>`_ have been tested in production. Hosted proxies like `Cloudflare <https://www.cloudflare.com/>`_ should also work well.
|
||||
|
||||
Wagtail supports automatic cache invalidation for Varnish/Squid. See :ref:`frontend_cache_purging` for more information.
|
||||
|
|
|
@ -125,7 +125,7 @@ Third-Party Apps
|
|||
``taggit``
|
||||
Tagging framework for Django. This is used internally within Wagtail for image and document tagging and is available for your own models as well. See :ref:`tagging` for a Wagtail model recipe or the `Taggit Documentation`_.
|
||||
|
||||
.. _Taggit Documentation: http://django-taggit.readthedocs.org/en/latest/index.html
|
||||
.. _Taggit Documentation: https://django-taggit.readthedocs.org/en/latest/index.html
|
||||
|
||||
``modelcluster``
|
||||
Extension of Django ForeignKey relation functionality, which is used in Wagtail pages for on-the-fly related object creation. For more information, see :ref:`inline_panels` or `the django-modelcluster github project page`_.
|
||||
|
@ -843,7 +843,7 @@ These two files should reside in your project directory (``myproject/myproject/`
|
|||
# A sample logging configuration. The only tangible logging
|
||||
# performed by this configuration is to send an email to
|
||||
# the site admins on every HTTP 500 error when DEBUG=False.
|
||||
# See http://docs.djangoproject.com/en/dev/topics/logging for
|
||||
# See https://docs.djangoproject.com/en/dev/topics/logging for
|
||||
# more details on how to customize your logging configuration.
|
||||
LOGGING = {
|
||||
'version': 1,
|
||||
|
|
|
@ -163,4 +163,4 @@ Filling in the ``path`` / ``numchild`` / ``depth`` fields is necessary in order
|
|||
The `Treebeard docs`_ might help in understanding how this works.
|
||||
|
||||
.. _dumpdata: https://docs.djangoproject.com/en/2.0/ref/django-admin/#django-admin-dumpdata
|
||||
.. _Treebeard docs: http://django-treebeard.readthedocs.io/en/latest/mp_tree.html
|
||||
.. _Treebeard docs: https://django-treebeard.readthedocs.io/en/latest/mp_tree.html
|
||||
|
|
|
@ -24,20 +24,20 @@ Third-party tutorials
|
|||
* `Wagtail-Multilingual: a simple project to demonstrate how multilingual is implemented <https://github.com/cristovao-alves/Wagtail-Multilingual>`_ (31 January 2017)
|
||||
* `Wagtail: 2 Steps for Adding Pages Outside of the CMS <https://www.caktusgroup.com/blog/2016/02/15/wagtail-2-steps-adding-pages-outside-cms/>`_ (15 February 2016)
|
||||
* `Adding a Twitter Widget for Wagtail’s new StreamField <https://jossingram.wordpress.com/2015/04/02/adding-a-twitter-widget-for-wagtails-new-streamfield/>`_ (2 April 2015)
|
||||
* `Working With Wagtail: Menus <http://www.tivix.com/blog/working-with-wagtail-menus/>`_ (22 January 2015)
|
||||
* `Working With Wagtail: Menus <https://www.tivix.com/blog/working-with-wagtail-menus/>`_ (22 January 2015)
|
||||
* `Upgrading Wagtail to use Django 1.7 locally using vagrant <https://jossingram.wordpress.com/2014/12/10/upgrading-wagtail-to-use-django-1-7-locally-using-vagrant/>`_ (10 December 2014)
|
||||
* `Wagtail redirect page. Can link to page, URL and document <https://gist.github.com/alej0varas/e7e334643ceab6e65744>`_ (24 September 2014)
|
||||
* `Outputing JSON for a model with properties and db fields in Wagtail/Django <https://jossingram.wordpress.com/2014/09/24/outputing-json-for-a-model-with-properties-and-db-fields-in-wagtaildjango/>`_ (24 September 2014)
|
||||
* `Bi-lingual website using Wagtail CMS <https://jossingram.wordpress.com/2014/09/17/bi-lingual-website-using-wagtail-cms/>`_ (17 September 2014)
|
||||
* `Wagtail CMS – Lesser known features <https://jossingram.wordpress.com/2014/09/12/wagtail-cms-lesser-known-features/>`_ (12 September 2014)
|
||||
* `Wagtail notes: stateful on/off hallo.js plugins <http://www.coactivate.org/projects/ejucovy/blog/2014/08/09/wagtail-notes-stateful-onoff-hallojs-plugins/>`_ (9 August 2014)
|
||||
* `Wagtail notes: stateful on/off hallo.js plugins <https://www.coactivate.org/projects/ejucovy/blog/2014/08/09/wagtail-notes-stateful-onoff-hallojs-plugins/>`_ (9 August 2014)
|
||||
* `Add some blockquote buttons to Wagtail CMS’ WYSIWYG Editor <https://jossingram.wordpress.com/2014/07/24/add-some-blockquote-buttons-to-wagtail-cms-wysiwyg-editor/>`_ (24 July 2014)
|
||||
* `Adding Bread Crumbs to the front end in Wagtail CMS <https://jossingram.wordpress.com/2014/07/01/adding-bread-crumbs-to-the-front-end-in-wagtail-cms/>`_ (1 July 2014)
|
||||
* `Extending hallo.js using Wagtail hooks <https://gist.github.com/jeffrey-hearn/502d0914fa4a930f08ac>`_ (9 July 2014)
|
||||
* `Wagtail notes: custom tabs per page type <http://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-custom-tabs-per-page-type/>`_ (10 May 2014)
|
||||
* `Wagtail notes: managing redirects as pages <http://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-managing-redirects-as-pages/>`_ (10 May 2014)
|
||||
* `Wagtail notes: dynamic templates per page <http://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-dynamic-templates-per-page/>`_ (10 May 2014)
|
||||
* `Wagtail notes: type-constrained PageChooserPanel <http://www.coactivate.org/projects/ejucovy/blog/2014/05/09/wagtail-notes-type-constrained-pagechooserpanel/>`_ (9 May 2014)
|
||||
* `Wagtail notes: custom tabs per page type <https://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-custom-tabs-per-page-type/>`_ (10 May 2014)
|
||||
* `Wagtail notes: managing redirects as pages <https://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-managing-redirects-as-pages/>`_ (10 May 2014)
|
||||
* `Wagtail notes: dynamic templates per page <https://www.coactivate.org/projects/ejucovy/blog/2014/05/10/wagtail-notes-dynamic-templates-per-page/>`_ (10 May 2014)
|
||||
* `Wagtail notes: type-constrained PageChooserPanel <https://www.coactivate.org/projects/ejucovy/blog/2014/05/09/wagtail-notes-type-constrained-pagechooserpanel/>`_ (9 May 2014)
|
||||
|
||||
You can also find more resources from the community on `Awesome Wagtail <https://github.com/springload/awesome-wagtail>`_.
|
||||
|
||||
|
|
|
@ -7,8 +7,8 @@ Compiling
|
|||
~~~~~~~~~
|
||||
|
||||
The SCSS source files are compiled to CSS using the
|
||||
`gulp <http://gulpjs.com/>`_ build system.
|
||||
This requires `Node.js <http://nodejs.org>`_ to run.
|
||||
`gulp <https://gulpjs.com/>`_ build system.
|
||||
This requires `Node.js <https://nodejs.org>`_ to run.
|
||||
To install the libraries required for compiling the SCSS,
|
||||
run the following from the Wagtail repository root:
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ Setting up the Wagtail codebase
|
|||
Install Node.js, version 8. Instructions for installing Node.js can be found on the `Node.js download page <https://nodejs.org/download/>`_.
|
||||
You can also use Node version manager (nvm) since Wagtail supplies a ``.nvmrc`` file in the root of the project with the minimum required Node version - see nvm's `installation instructions <https://github.com/creationix/nvm>`_.
|
||||
|
||||
You will also need to install the **libjpeg** and **zlib** libraries, if you haven't done so already - see Pillow's `platform-specific installation instructions <http://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
You will also need to install the **libjpeg** and **zlib** libraries, if you haven't done so already - see Pillow's `platform-specific installation instructions <https://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
|
||||
Clone a copy of `the Wagtail codebase <https://github.com/wagtail/wagtail>`_:
|
||||
|
||||
|
|
|
@ -12,6 +12,6 @@ Principles
|
|||
~~~~~~~~~~
|
||||
|
||||
* Write `valid HTML <https://validator.w3.org/nu/>`_. We target the HTML5 doctype.
|
||||
* Write `semantic HTML <http://html5doctor.com/element-index/>`_.
|
||||
* Write `semantic HTML <https://html5doctor.com/element-index/>`_.
|
||||
* Attach JavaScript behavior with ``data-`` attributes, rather than classes or IDs.
|
||||
* For comments, use Django templates syntax instead of HTML.
|
||||
|
|
|
@ -8,7 +8,7 @@ Issues
|
|||
|
||||
An issue must always correspond to a specific action with a well-defined completion state: fixing a bug, adding a new feature, updating documentation, cleaning up code. Open-ended issues where the end result is not immediately clear ("come up with a way of doing translations") are fine, as long as there's a clear way to progress the issue and identify when it has been completed (not e.g. "make rich text fields suck less").
|
||||
|
||||
Do not use issues for support queries or other questions ("How do I do X?" - although "Implement a way of doing X" or "Document how to do X" could well be valid issues). These should be asked on `Stack Overflow <http://stackoverflow.com/questions/tagged/wagtail>`_, or for discussions that do not fit Stack Overflow's question-and-answer format, the `Wagtail Support Google group <https://groups.google.com/forum/#!forum/wagtail>`_.
|
||||
Do not use issues for support queries or other questions ("How do I do X?" - although "Implement a way of doing X" or "Document how to do X" could well be valid issues). These should be asked on `Stack Overflow <https://stackoverflow.com/questions/tagged/wagtail>`_, or for discussions that do not fit Stack Overflow's question-and-answer format, the `Wagtail Support Google group <https://groups.google.com/forum/#!forum/wagtail>`_.
|
||||
|
||||
As soon as a ticket is opened - ideally within one day - a member of the core team will give it an initial classification, by either closing it as invalid or assigning it to a milestone. Don't be discouraged if you feel that your ticket has been given a lower priority than it deserves - this decision isn't permanent. We will consider all feedback, and reassign or reopen tickets where appropriate.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
JavaScript coding guidelines
|
||||
============================
|
||||
|
||||
Write JavaScript according to the `Airbnb Styleguide <http://github.com/airbnb/javascript>`_, with some exceptions:
|
||||
Write JavaScript according to the `Airbnb Styleguide <https://github.com/airbnb/javascript>`_, with some exceptions:
|
||||
|
||||
- Use soft-tabs with a four space indent. Spaces are the only way to
|
||||
guarantee code renders the same in any person's environment.
|
||||
|
|
|
@ -4,11 +4,11 @@ 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) and some minor docstring-related issues.
|
||||
We ask that all Python contributions adhere to the `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ style guide, apart from the restriction on line length (E501) and some minor docstring-related issues.
|
||||
The list of PEP8 violations to ignore is in the ``setup.cfg`` file, under the ``[flake8]`` header.
|
||||
You might want to configure the flake8 linter in your editor/IDE to use the configuration in this file.
|
||||
|
||||
In addition, import lines should be sorted according to `isort <http://timothycrosley.github.io/isort/>`_ 4.2.5 rules. If you have installed Wagtail's testing dependencies (``pip install -e .[testing]``), you can check your code by running ``make lint``.
|
||||
In addition, import lines should be sorted according to `isort <https://timothycrosley.github.io/isort/>`_ 4.2.5 rules. If you have installed Wagtail's testing dependencies (``pip install -e .[testing]``), you can check your code by running ``make lint``.
|
||||
|
||||
Django compatibility
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
|
@ -53,7 +53,7 @@ issued from those branches.
|
|||
Release cadence
|
||||
===============
|
||||
|
||||
Wagtail uses a loose form of `semantic versioning <http://semver.org/>`_.
|
||||
Wagtail uses a loose form of `semantic versioning <https://semver.org/>`_.
|
||||
SemVer makes it easier to see at a glance how compatible releases are with each
|
||||
other. It also helps to anticipate when compatibility shims will be removed.
|
||||
It's not a pure form of SemVer as each feature release will continue to have a
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
Browser issues
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Some issues with Wagtail may come from the browser. Try `clearing the browser cache and cookies <http://www.refreshyourcache.com/>`_, or you can also try using Wagtail with `another browser <http://browsehappy.com/>`_ to see if the problem persists.
|
||||
Some issues with Wagtail may come from the browser. Try `clearing the browser cache and cookies <https://www.refreshyourcache.com/>`_, or you can also try using Wagtail with `another browser <https://browsehappy.com/>`_ to see if the problem persists.
|
||||
|
||||
JavaScript is required to use Wagtail – make sure it is `enabled in your browser <http://www.enable-javascript.com/>`_.
|
||||
JavaScript is required to use Wagtail – make sure it is `enabled in your browser <https://www.enable-javascript.com/>`_.
|
||||
|
||||
Supported browsers
|
||||
__________________
|
||||
|
||||
For the best experience and security, we recommend that you keep your browser up to date. Go to `Browse Happy <http://browsehappy.com/>`_ for more information.
|
||||
For the best experience and security, we recommend that you keep your browser up to date. Go to `Browse Happy <https://browsehappy.com/>`_ for more information.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
Introduction
|
||||
------------
|
||||
|
||||
`Wagtail <http://www.wagtail.io>`_ is a new open source content management system (CMS) developed by `Torchbox <http://www.torchbox.com>`_. It is built on the Django framework and designed to be super easy to use for both developers and editors.
|
||||
`Wagtail <https://wagtail.io>`_ is a new open source content management system (CMS) developed by `Torchbox <https://torchbox.com>`_. It is built on the Django framework and designed to be super easy to use for both developers and editors.
|
||||
|
||||
This documentation will explain how to:
|
||||
|
||||
|
|
|
@ -13,7 +13,7 @@ Dependencies needed for installation
|
|||
|
||||
* `Python 3 <https://www.python.org/downloads/>`_
|
||||
* **libjpeg** and **zlib**, libraries required for Django's **Pillow** library.
|
||||
See Pillow's `platform-specific installation instructions <http://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
See Pillow's `platform-specific installation instructions <https://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
|
||||
|
||||
Quick install
|
||||
|
|
|
@ -11,7 +11,7 @@ Wagtail is currently compatible with Django 2.0, 2.1 and 2.2. First, install the
|
|||
|
||||
$ pip install wagtail
|
||||
|
||||
or add the package to your existing requirements file. This will also install the **Pillow** library as a dependency, which requires libjpeg and zlib - see Pillow's `platform-specific installation instructions <http://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
or add the package to your existing requirements file. This will also install the **Pillow** library as a dependency, which requires libjpeg and zlib - see Pillow's `platform-specific installation instructions <https://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
|
||||
Settings
|
||||
--------
|
||||
|
|
|
@ -24,7 +24,7 @@ If this does not return a version number or returns a version lower than 3.5, yo
|
|||
.. important::
|
||||
Before installing Wagtail, it is necessary to install the **libjpeg** and **zlib** libraries, which provide support for working with JPEG, PNG and GIF images (via the Python **Pillow** library).
|
||||
The way to do this varies by platform—see Pillow's
|
||||
`platform-specific installation instructions <http://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
`platform-specific installation instructions <https://pillow.readthedocs.org/en/latest/installation.html#external-libraries>`_.
|
||||
|
||||
|
||||
Create and activate a virtual environment
|
||||
|
|
|
@ -47,7 +47,7 @@ Set ``WAGTAILFRONTENDCACHE_LANGUAGES`` to a list of languages (typically equal t
|
|||
Finally, make sure you have configured your frontend cache to accept PURGE requests:
|
||||
|
||||
- `Varnish <https://www.varnish-cache.org/docs/3.0/tutorial/purging.html>`_
|
||||
- `Squid <http://wiki.squid-cache.org/SquidFaq/OperatingSquid#How_can_I_purge_an_object_from_my_cache.3F>`_
|
||||
- `Squid <https://wiki.squid-cache.org/SquidFaq/OperatingSquid#How_can_I_purge_an_object_from_my_cache.3F>`_
|
||||
|
||||
|
||||
.. _frontendcache_cloudflare:
|
||||
|
@ -93,7 +93,7 @@ Add an item into the ``WAGTAILFRONTENDCACHE`` and set the ``BACKEND`` parameter
|
|||
},
|
||||
}
|
||||
|
||||
Configuration of credentials can done in multiple ways. You won't need to store them in your Django settings file. You can read more about this here: `Boto 3 Docs <http://boto3.readthedocs.org/en/latest/guide/configuration.html>`_
|
||||
Configuration of credentials can done in multiple ways. You won't need to store them in your Django settings file. You can read more about this here: `Boto 3 Docs <https://boto3.readthedocs.org/en/latest/guide/configuration.html>`_
|
||||
|
||||
In case you run multiple sites with Wagtail and each site has its CloudFront distribution, provide a mapping instead of a single distribution. Make sure the mapping matches with the hostnames provided in your site settings.
|
||||
|
||||
|
|
|
@ -665,7 +665,7 @@ change a few attributes to change the thumbnail to your liking, like so:
|
|||
# Optionally specify a fallback image to be used when the object doesn't
|
||||
# have an image set, or the image has been deleted. It can an image from
|
||||
# your static files folder, or an external URL.
|
||||
thumb_default = 'http://lorempixel.com/100/100'
|
||||
thumb_default = 'https://lorempixel.com/100/100'
|
||||
|
||||
|
||||
.. _modeladmin_list_display_add_buttons:
|
||||
|
|
|
@ -98,7 +98,7 @@ You can prevent the ``update_index`` command from indexing any data by using the
|
|||
wagtail_update_index
|
||||
--------------------
|
||||
|
||||
An alias for the ``update_index`` command that can be used when another installed package (such as `Haystack <http://haystacksearch.org/>`_) provides a command named ``update_index``. In this case, the other package's entry in ``INSTALLED_APPS`` should appear above ``wagtail.search`` so that its ``update_index`` command takes precedence over Wagtail's.
|
||||
An alias for the ``update_index`` command that can be used when another installed package (such as `Haystack <https://haystacksearch.org/>`_) provides a command named ``update_index``. In this case, the other package's entry in ``INSTALLED_APPS`` should appear above ``wagtail.search`` so that its ``update_index`` command takes precedence over Wagtail's.
|
||||
|
||||
|
||||
.. _search_garbage_collect:
|
||||
|
|
|
@ -108,7 +108,7 @@ In addition to the model fields provided, ``Page`` has many properties and metho
|
|||
|
||||
.. note::
|
||||
|
||||
See also `django-treebeard <http://django-treebeard.readthedocs.io/en/latest/index.html>`_'s `node API <http://django-treebeard.readthedocs.io/en/latest/api.html>`_. ``Page`` is a subclass of `materialized path tree <http://django-treebeard.readthedocs.io/en/latest/mp_tree.html>`_ nodes.
|
||||
See also `django-treebeard <https://django-treebeard.readthedocs.io/en/latest/index.html>`_'s `node API <https://django-treebeard.readthedocs.io/en/latest/api.html>`_. ``Page`` is a subclass of `materialized path tree <https://django-treebeard.readthedocs.io/en/latest/mp_tree.html>`_ nodes.
|
||||
|
||||
|
||||
.. class:: Page
|
||||
|
|
|
@ -8,7 +8,7 @@ Theory
|
|||
Introduction to Trees
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you're unfamiliar with trees as an abstract data type, you might want to `review the concepts involved. <http://en.wikipedia.org/wiki/Tree_(data_structure)>`_
|
||||
If you're unfamiliar with trees as an abstract data type, you might want to `review the concepts involved. <https://en.wikipedia.org/wiki/Tree_(data_structure)>`_
|
||||
|
||||
As a web developer, though, you probably already have a good understanding of trees as filesystem directories or paths. Wagtail pages can create the same structure, as each page in the tree has its own URL path, like so::
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@ If you have any problems or questions about working with Wagtail, you are invite
|
|||
Stack Overflow
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
`Stack Overflow <http://stackoverflow.com/questions/tagged/wagtail>`_ is the best place to find answers to your questions about working with Wagtail - there is an active community of Wagtail users and developers responding to questions there. When posting questions, please read Stack Overflow's advice on `how to ask questions <http://stackoverflow.com/help/how-to-ask>`_ and remember to tag your question with "wagtail".
|
||||
`Stack Overflow <https://stackoverflow.com/questions/tagged/wagtail>`_ is the best place to find answers to your questions about working with Wagtail - there is an active community of Wagtail users and developers responding to questions there. When posting questions, please read Stack Overflow's advice on `how to ask questions <https://stackoverflow.com/help/how-to-ask>`_ and remember to tag your question with "wagtail".
|
||||
|
||||
Mailing list
|
||||
~~~~~~~~~~~~
|
||||
|
@ -32,4 +32,4 @@ If you think you've found a bug in Wagtail, or you'd like to suggest a new featu
|
|||
Torchbox
|
||||
~~~~~~~~
|
||||
|
||||
Finally, if you have a query which isn't relevant for any of the above forums, feel free to contact the Wagtail team at Torchbox directly, on `hello@wagtail.io <mailto:hello@wagtail.io>`_ or `@wagtailcms <http://twitter.com/wagtailcms>`_.
|
||||
Finally, if you have a query which isn't relevant for any of the above forums, feel free to contact the Wagtail team at Torchbox directly, on `hello@wagtail.io <mailto:hello@wagtail.io>`_ or `@wagtailcms <https://twitter.com/wagtailcms>`_.
|
||||
|
|
|
@ -173,7 +173,7 @@ If you prefer not to run an Elasticsearch server in development or production, t
|
|||
- Configure ``URLS`` in the Elasticsearch entry in ``WAGTAILSEARCH_BACKENDS`` using the Cluster URL from your Bonsai dashboard
|
||||
- Run ``./manage.py update_index``
|
||||
|
||||
.. _elasticsearch-py: http://elasticsearch-py.readthedocs.org
|
||||
.. _elasticsearch-py: https://elasticsearch-py.readthedocs.org
|
||||
.. _Bonsai: https://bonsai.io/signup
|
||||
|
||||
Amazon AWS Elasticsearch
|
||||
|
|
|
@ -58,7 +58,7 @@ The search may not return any results while this command is running, so avoid ru
|
|||
|
||||
.. note::
|
||||
|
||||
The ``update_index`` command is also aliased as ``wagtail_update_index``, for use when another installed package (such as `Haystack <http://haystacksearch.org/>`_) provides a conflicting ``update_index`` command. In this case, the other package's entry in ``INSTALLED_APPS`` should appear above ``wagtail.search`` so that its ``update_index`` command takes precedence over Wagtail's.
|
||||
The ``update_index`` command is also aliased as ``wagtail_update_index``, for use when another installed package (such as `Haystack <https://haystacksearch.org/>`_) provides a conflicting ``update_index`` command. In this case, the other package's entry in ``INSTALLED_APPS`` should appear above ``wagtail.search`` so that its ``update_index`` command takes precedence over Wagtail's.
|
||||
|
||||
|
||||
.. _wagtailsearch_indexing_fields:
|
||||
|
|
|
@ -9,7 +9,7 @@
|
|||
# the 'mywagtail' user account, with the application deployed in
|
||||
# /home/mywagtail/app and the virtualenv in /home/mywagtail/venv.
|
||||
#
|
||||
# [0] http://uwsgi-docs.readthedocs.org/en/latest/Emperor.html
|
||||
# [0] https://uwsgi-docs.readthedocs.org/en/latest/Emperor.html
|
||||
|
||||
[uwsgi]
|
||||
# Abort on unknown configuration options.
|
||||
|
|
|
@ -20,7 +20,7 @@ if [ -z "${AWS_CLI}" ]; then
|
|||
|
||||
if [ -z "${AWS_CLI}" ]; then
|
||||
printf >&2 -- '%s: cannot find AWS CLI binary "aws"\n' "$0"
|
||||
printf >&2 -- '%s: please install AWS from http://aws.amazon.com/documentation/cli/\n' "$0"
|
||||
printf >&2 -- '%s: please install AWS from https://aws.amazon.com/documentation/cli/\n' "$0"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
|
6
setup.py
6
setup.py
|
@ -74,8 +74,8 @@ setup(
|
|||
version=__version__,
|
||||
description='A Django content management system.',
|
||||
author='Wagtail core team + contributors',
|
||||
author_email='hello@wagtail.io', # For support queries, please see http://docs.wagtail.io/en/stable/support.html
|
||||
url='http://wagtail.io/',
|
||||
author_email='hello@wagtail.io', # For support queries, please see https://docs.wagtail.io/en/stable/support.html
|
||||
url='https://wagtail.io/',
|
||||
packages=find_packages(),
|
||||
include_package_data=True,
|
||||
license='BSD',
|
||||
|
@ -83,7 +83,7 @@ setup(
|
|||
system built on Django, with a strong community and commercial support. \
|
||||
It’s focused on user experience, and offers precise control for \
|
||||
designers and developers.\n\n\
|
||||
For more details, see https://wagtail.io, http://docs.wagtail.io and \
|
||||
For more details, see https://wagtail.io, https://docs.wagtail.io and \
|
||||
https://github.com/wagtail/wagtail/.",
|
||||
classifiers=[
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
|
|
|
@ -15,7 +15,7 @@ def css_install_check(app_configs, **kwargs):
|
|||
error_hint = """
|
||||
Most likely you are running a development (non-packaged) copy of
|
||||
Wagtail and have not built the static assets -
|
||||
see http://docs.wagtail.io/en/latest/contributing/developing.html
|
||||
see https://docs.wagtail.io/en/latest/contributing/developing.html
|
||||
|
||||
File not found: %s
|
||||
""" % css_path
|
||||
|
|
|
@ -20,12 +20,12 @@
|
|||
</head>
|
||||
<body id="wagtail" class="{% block bodyclass %}{% endblock %} {% if messages %}has-messages{% endif %} focus-outline-on">
|
||||
<!--[if lt IE 9]>
|
||||
<p class="capabilitymessage">{% blocktrans %}You are using an <strong>outdated</strong> browser not supported by this software. Please <a href="http://browsehappy.com/">upgrade your browser</a>.{% endblocktrans %}</p>
|
||||
<p class="capabilitymessage">{% blocktrans %}You are using an <strong>outdated</strong> browser not supported by this software. Please <a href="https://browsehappy.com/">upgrade your browser</a>.{% endblocktrans %}</p>
|
||||
<![endif]-->
|
||||
<noscript class="capabilitymessage">
|
||||
{% blocktrans %}
|
||||
Javascript is required to use Wagtail, but it is currently disabled.<br />
|
||||
Here are the <a href="http://www.enable-javascript.com/" target="_blank" rel="noopener noreferrer">instructions how to enable JavaScript in your web browser</a>.
|
||||
Here are the <a href="https://www.enable-javascript.com/" target="_blank" rel="noopener noreferrer">instructions how to enable JavaScript in your web browser</a>.
|
||||
{% endblocktrans %}
|
||||
</noscript>
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ WAGTAIL_APPEND_SLASH = getattr(settings, 'WAGTAIL_APPEND_SLASH', True)
|
|||
|
||||
|
||||
def camelcase_to_underscore(str):
|
||||
# http://djangosnippets.org/snippets/585/
|
||||
# https://djangosnippets.org/snippets/585/
|
||||
return re.sub('(((?<=[a-z])[A-Z])|([A-Z](?![A-Z]|$)))', '_\\1', str).lower().strip('_')
|
||||
|
||||
|
||||
|
|
Ładowanie…
Reference in New Issue