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

115 Commits

Author SHA1 Message Date
Matt Westcott
cc9310220a Fix documentation build warnings 2021-04-15 17:17:11 +01:00
Daniele Procida
4f8ef843d0 Update links to Diátaxis framework
Information about the documentation system is now maintained and updated
at https://diataxis.fr.
2021-04-12 14:34:04 +01:00
Naomi I. Morduch Toubman
664b0489fe
Change master to main (#6830)
* Update references to `master` branch to say `main`

* Update external links

* Update links in old release notes
  Use tagged versions of code rather than current code
2021-03-03 13:33:19 -05:00
Storm Heg
24ef0e62e6 Fix documentation indentation
Fix code block indentation in tutorial.rst

Prevent it from being displayed as a quote.

Fix indentation in pages.rst

Fix indentation in indexing.rst

Fix indentation in searching.rst

Fix indentation in backends.rst

Fix indentation in renditions.rst

Fix indentation in custom_image_model.rst

Fix indentation in feature_detection.rst

Fix indentation in image_serve_view.rst

Fix indentation in custom_document_model.rst

Fix indentation in i18n.rst

Fix indentation in privacy.rst

Fix indentation in page_editing_interface.rst

Fix indentation in rich_text_internals.rst

Fix indentation in extending_hallo.rst

Fix indentation in configuration.rst

Fix indentation in usage.rst

Fix indentation in theory.rst

Fix indentation in model_reference.rst

Fix indentation in queryset_reference.rst

Configure editors to indent .rst files with 2 spaces

In order for the documentation to be styled correctly, the generator
depends on indentation. Too much indentation can result in the content
being wrapped in a quote block, which looks bad.

Fix indentation in sitemaps.rst

Fix indentation in frontendcache.rst

Fix indentation in routablepage.rst

Fix indentation in table_block.rst

Fix routablepage.rst autodocs disppearing

Fix indentation in table_block.rst

Fix indentation in redirects.rst

Fix indentation in table_documentation-modes.rst

Fix indentation in browser_issues.rst

Fix indentation in release_process.rst

Fix indentation of release notes

One more indent fix in the release notes

Fix indentation warnings

Fix warning about undefined label in docs

Error during `make html`:

  wagtail/docs/releases/1.7.rst:25: WARNING: undefined label: jpeg_image_quality
2021-02-26 09:17:00 +00:00
Tibor Leupold
aefff4e56c
Docs: Convert "reporting security issues" from RST to MD (#6829)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2021-02-23 10:26:12 +00:00
Matt Westcott
4c278d81a1
Move "writing documentation" page into Contributing (#6789)
While we very much want to introduce an "explanation" section in some form, I don't think this should be the inaugural item in that section, as it's 'meta' documentation about the Wagtail documentation process, rather than information directed at Wagtail site creators.
2021-02-05 09:29:03 -05:00
Storm Heg
d3285e9f1b Quote pip install command in developing docs
Prevents it from failing with zsh: no matches found: .[docs]
2021-02-04 12:36:00 +00:00
Thibaud Colas
29942d2a48
Add documentation formatting reference (#6729)
Co-authored-by: Andy Chosak <andy@chosak.org>
Co-authored-by: Tom Dyson <tom@torchbox.com>
2021-01-29 10:38:47 +00:00
David Beitey
3a5b7255ad Change UniqueConstraint for wider database support (#6607)
This fixes #6393 by modifying the constraint to use an IN condition
which supports both Postgres and SQL Server. Previously, the `|` (OR)
condition was only supported by Postgres because SQL Server only
supports AND conditions.

The implementation follows suggestions from @gasman in
https://github.com/wagtail/wagtail/issues/6393#issuecomment-732161057:

* Migration 0050 is modified to not break on SQL Server
* Added migration 0060 to add or replace the constraint

Additionally, this allows for and documents a `DATABASE_DRIVER` env
variable to be set for testing, to allow a different SQL Server driver
(e.g. FreeTDS on Mac/Linux); and adds the specific `host_is_server`
option for FreeTDS (won't affect SQL Server Native Client on CI).
2021-01-18 11:52:52 +00:00
David Beitey
3c3df689f7
Fix formatting in Development documentation (#6686)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2021-01-13 13:26:41 +00:00
David Beitey
67235accfc Improve database settings and docs for tests (#6585)
This change makes several improvements:

* Use in-memory SQLite database for test migrations

  The default database is SQLite but its NAME (which SQLite uses as the
  filename) was `wagtail`, which isn't valid since
  the wagtail codebase already has a `wagtail/` directory.  Trying to
  run migration creation commands
  (https://docs.wagtail.io/en/latest/contributing/developing.html#running-migrations-for-the-test-app-models)
  produced an error:

  django.db.utils.OperationalError: unable to open database file

  because of this conflict.

  This change uses an in-memory database as the default database for
  tests. If DATABASE_NAME were set to a real file name, then
  running the migration command with SQLite creates an empty db with
  this filename on running `django-admin`.

  Other non-SQLite engines continue to use the original `wagtail` name,
  meaning that the `test_wagtail` database gets created just as before.

* Modifies the default values for database USER, PASSWORD, HOST etc to
  being an empty string rather than None, to match Django's
  [defaults](https://docs.djangoproject.com/en/stable/ref/settings/#host).
  This helps avoid any potential issues when Django and database engines
  are expecting this being a string.

* Adds documentation to `developing.rst` regarding installation of
  required database modules and available environment variables for database
  connection customisation

* Normalises the DATABASE_PASSWORD tests environment variable to match
  the name in Django's database settings object
2020-12-09 15:28:44 +00:00
Matt Westcott
4d6a41a83b Drop travis entirely 2020-11-05 12:04:12 +00:00
Matt Westcott
9947b955da Lint config fixes (#6473)
Ref #6463, #6428

* pin isort to 5.6.4
* update isort version mentioned in python_guidelines.rst
* make lint commands consistent between make lint and circleci
* fix isort errors on files outside of /wagtail
* speed up isort by ignoring additional directories and filetypes
2020-10-19 21:33:10 +01:00
Frantisek Holop
07a4b41444 deprecated 2020-10-05 14:23:50 +01:00
Karl Hobley
39d931d77d Javascript => JavaScript 2020-10-03 14:43:03 +01:00
Karl Hobley
6e5f89adf2 General spelling fixes 2020-10-03 14:43:03 +01:00
Karl Hobley
9195131738 Lint docs with doc8 2020-10-03 14:43:03 +01:00
Jesse Menn
b934194622
Make page-level actions accessible to keyboard users in page listing tables (#6280)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2020-08-01 21:52:28 +01:00
Coen van der Kamp
99abab5d6b Add section to explain commit to pull request 2020-05-19 17:56:26 +01:00
Jim Jazwiecki
6ea0cc52f3 Upgrade to Gulp v4 & Node 10
* Syntax changes to get Gulp working
* Require Node 10, use node 10 in CircleCI and squash.yml
* Update docs
* resolves #5653
2020-05-01 12:01:03 +10:00
LB
78e3c5964d Docs & readme - remove references to now closed developers forum
- remove references to https://groups.google.com/forum/#!forum/wagtail-developers
- add references to the Wagtail slack workspace
2020-04-20 16:27:14 +01:00
Matt Westcott
ef0c8f3446 Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00
Thibaud Colas
676503023d
Mention docker-wagtail-develop in developing docs (#5820)
Based on discussion in #bristol-sprint on Slack. See also https://github.com/wagtail/vagrant-wagtail-develop/pull/25.
2020-02-12 14:11:40 +01:00
Andy Chosak
43acf24cc8 Always include contributor names in the CHANGELOG
The CHANGELOG docs say that contributor names should only be included if
they are not a core committer, but historical practice has been to
always include names. Per discussion on the core team, we want to change
this guidance to explicitly recommend always including contributor
names.

This not only encourages and recognizes contributions but also helps
future contributors know who worked on different parts of the code. This
record (along with git history) provides a good reference to understand
who made certain changes or features.
2020-01-27 09:25:42 -05:00
Martey Dodoo
229103ff2e Update links in documentation. (#5689)
Use HTTPS links instead of non-secure HTTP links wherever possible in
documentation.
2019-11-08 09:15:01 +00:00
Matt Westcott
3e98563340
Drop support for Django 2.0 (#5684) 2019-11-06 17:05:04 +00:00
Sergey Fedoseev
eab9198f4c Move flake8 config to setup.cfg 2019-10-23 18:09:07 +02:00
Thibaud Colas
3710d1d6b2
Clarify CHANGELOG instructions in "Committing code" docs (#5483) 2019-08-05 13:35:29 +01:00
Tom Dyson
ff850026e8 Adjust link label 2019-06-25 12:10:34 +01:00
Tom Dyson
08a301b3ce Clarify new three month release policy 2019-06-25 12:10:34 +01:00
Thibaud Colas
059c139515 Remove bad practice example from CSS guidelines 2019-06-06 17:04:23 +01:00
Thibaud Colas
15a8907e44 Document partial focus outline support in IE11 2019-05-28 11:53:26 +01:00
LB Johnston
275d28cbff Update JS Docs to reference eslint instead of JS Code Style
- it does not appear that JavaScript code style is in use
- also revise the formatting script to align with actual scripts
2019-05-20 16:42:35 +01:00
LB Johnston
cbe8020527 Docs: Update CSS Guidelines to align with new shared config
- also make changes to set up similar sections to JS docs
2019-05-20 16:42:35 +01:00
Thibaud Colas
effb0866b4 Update accessibility-related docs to clarify tools usage and reflect feedback 2019-04-29 13:55:41 +01:00
Thibaud Colas
e78d1c5410 Document accessibility targets and browser extensions to use 2019-04-29 13:55:41 +01:00
Thibaud Colas
374d35f945 Add linkable sub-sections to Testing in development docs 2019-04-29 13:55:41 +01:00
Thibaud Colas
a51631c306 Add jinjalint linter for Django templates, allowing errors for now 2019-04-29 13:55:41 +01:00
Matt Westcott
3134ffa119 Recommend npm install --no-save when setting up node toolchain (#5161)
Running `npm install` without `--no-save` can introduce spurious changes to package-lock.json due to differences in platform / node version, and these have been known to accidentally sneak into people's PRs. `npm install` without `--no-save` should only be used when actively updating node dependencies in package.json.
2019-03-21 20:41:14 +00:00
Benjamin Bach
5b0f2e1a54 First positional argument for tox as test module/case path 2018-10-30 12:16:45 +00:00
FedorSelitsky
6d79169dad Add PyPI trove classifiers for Wagtail 2018-10-28 16:43:42 +03:00
Matt Westcott
06d8fb0f63 Add guideline on the use of British vs American English 2018-06-27 20:39:08 +01:00
strotherscott
c5357dd271 second attempt ro clarify issue #4620 2018-06-18 15:04:41 +01:00
Thibaud Colas
4803ad1c43 Add IE11 opt-out of rich text pasting, and documentation notes 2018-01-17 22:16:35 +02:00
Matt Westcott
ff0daf074d Add line break to makemigrations code snippet 2017-11-27 01:11:09 +00:00
Karl Hobley
9a13b09d41 Renamed wagtail.contrib.wagtailstyleguide to wagtail.contrib.styleguide 2017-11-26 22:43:47 +00:00
Karl Hobley
4300e19da2 Rename wagtail.wagtailcore to wagtail.core 2017-11-26 22:43:47 +00:00
LB (Ben Johnston)
ebc423e91a Add instructions on how to do test app migrations
Previously answered [here](https://github.com/wagtail/wagtail/pull/4024#issuecomment-345267222) and [here](https://groups.google.com/forum/#!msg/wagtail-developers/P6x9N5qzq-I/0gbRzWgBBgAJ). Just adding this into these docs for future contributors.
2017-11-19 09:08:01 +00:00
Matt Westcott
392cd21014 Improve description of real-soon-now milestone 2017-11-17 14:39:12 +00:00
Matt Westcott
5f382d8784 Remove Python 2 references from docs 2017-10-13 12:24:42 +01:00