diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fdb3a27d27..d03d39a432 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thank you for considering to help Wagtail. -We welcome all support, whether on bug reports, code, design, reviews, tests, +We welcome all support, whether on bug reports, code, design, reviews, tests, documentation, translations or just feature requests. ## Using the issue tracker @@ -14,9 +14,9 @@ for support - use [the 'wagtail' tag on Stack Overflow](https://stackoverflow.co ## New code -Please review the -[contributing guidelines](https://docs.wagtail.io/en/latest/contributing/index.html). -You might like to start by checking issues with the +Please review the +[contributing guidelines](https://docs.wagtail.org/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. ## Code reviews @@ -29,4 +29,4 @@ Please submit any new or improved translations through [Transifex](https://www.t ## Accessibility testing -We’d love to get feedback on the accessibility of Wagtail. Get in touch with our [accessibility team](https://github.com/wagtail/wagtail/wiki/Accessibility-team) if you are testing Wagtail and want to report your findings, or have a look at our [backlog of accessibility issues and improvements](https://github.com/wagtail/wagtail/projects/5). We also document our [testing targets and known issues](https://docs.wagtail.io/en/latest/contributing/developing.html#accessibility-targets). +We’d love to get feedback on the accessibility of Wagtail. Get in touch with our [accessibility team](https://github.com/wagtail/wagtail/wiki/Accessibility-team) if you are testing Wagtail and want to report your findings, or have a look at our [backlog of accessibility issues and improvements](https://github.com/wagtail/wagtail/projects/5). We also document our [testing targets and known issues](https://docs.wagtail.org/en/latest/contributing/developing.html#accessibility-targets). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 152dd8985f..d51af5d55c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,11 @@ Thanks for contributing to Wagtail! 🎉 -Before submitting, please review the contributor guidelines and check the following: +Before submitting, please review the contributor guidelines and check the following: -* Do the tests still pass? (https://docs.wagtail.io/en/latest/contributing/developing.html#testing) +* Do the tests still pass? (https://docs.wagtail.org/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 environments](https://docs.wagtail.io/en/latest/contributing/developing.html#browser-and-device-support)? +* For front-end changes: Did you test on all of [Wagtail’s supported environments](https://docs.wagtail.org/en/latest/contributing/developing.html#browser-and-device-support)? * **Please list the exact browser and operating system versions you tested**. * **Please list which assistive technologies you tested**. * For new features: Has the documentation been updated accordingly? diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 2be3920186..2e568d7e02 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -27,6 +27,7 @@ Changelog * Add the user who submitted a page for moderation to the "Awaiting your review" homepage summary panel (Tidiane Dia) * When moving pages, default to the current parent section (Tidjani Dia) * `admin/expanding_formset.js` has been renamed to `admin/expanding-formset.js` (LB (Ben Johnston)) + * Change docs URL to docs.wagtail.org (Jake Howard) * Fix: Accessibility fixes for Windows high contrast mode; Dashboard icons colour and contrast (Sakshi Uppoor) * Fix: Rename additional 'spin' CSS animations to avoid clashes with other libraries (Kevin Gutiérrez) * Fix: `default_app_config` deprecations for Django >= 3.2 (Tibor Leupold) diff --git a/README.md b/README.md index 2321126a6b..4a67ebfcda 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ python manage.py createsuperuser python manage.py runserver ``` -For detailed installation and setup docs, see [docs.wagtail.io](https://docs.wagtail.io/). +For detailed installation and setup docs, see [docs.wagtail.org](https://docs.wagtail.org/). ### Who’s using it? @@ -48,11 +48,11 @@ Wagtail is used by [NASA](https://www.nasa.gov/), [Google](https://www.google.co ### Documentation -[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. +[docs.wagtail.org](https://docs.wagtail.org/) is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap. ### Compatibility -_(If you are reading this on GitHub, the details here may not be indicative of the current released version - please see [Compatible Django / Python versions](https://docs.wagtail.io/en/stable/releases/upgrading.html#compatible-django-python-versions) in the Wagtail documentation.)_ +_(If you are reading this on GitHub, the details here may not be indicative of the current released version - please see [Compatible Django / Python versions](https://docs.wagtail.org/en/stable/releases/upgrading.html#compatible-django-python-versions) in the Wagtail documentation.)_ Wagtail supports: @@ -60,7 +60,7 @@ Wagtail supports: * Python 3.7, 3.8, 3.9 and 3.10 * PostgreSQL, MySQL and SQLite as database backends -[Previous versions of Wagtail](https://docs.wagtail.io/en/stable/releases/upgrading.html#compatible-django-python-versions) additionally supported Python 2.7 and earlier Django versions. +[Previous versions of Wagtail](https://docs.wagtail.org/en/stable/releases/upgrading.html#compatible-django-python-versions) additionally supported Python 2.7 and earlier Django versions. --- @@ -96,7 +96,7 @@ To try out the latest features before a release, we also create builds from `mai If you're a Python or Django developer, fork the repo and get stuck in! We have several developer focused channels on the [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack). -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. +You might like to start by reviewing the [contributing guidelines](https://docs.wagtail.org/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/). diff --git a/docs/README.md b/docs/README.md index 7d507f0f64..3ffdea82b8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,12 @@ # Wagtail docs -These are Sphinx docs, automatically built at https://docs.wagtail.io when the `main` 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.org when the `main` branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory): pip install -e .[testing,docs] -To build the documentation for browsing, from this directory run: +To build the documentation for browsing, from this directory run: - make html + make html then open ``_build/html/index.html`` in a browser. diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index a4af226c28..22e6132856 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -9,7 +9,7 @@ {% endblock %} {% block search %} - +