Browse Source

auto-format core markdown files (#8603)

- clean up formatting on existing martkdown files to align with prettier
LB (Ben Johnston) 2 years ago
parent
commit
0012c344d9

+ 6 - 9
.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -1,10 +1,9 @@
 ---
-name: "🐞 Bug Report"
+name: '🐞 Bug Report'
 about: Create a report to help us improve
 title: ''
 labels: ['type:Bug', 'status:Unconfirmed']
 assignees: ''
-
 ---
 
 <!--
@@ -17,7 +16,6 @@ Found a bug? Please fill out the sections below. 👍
 A summary of the issue.
 -->
 
-
 ### Steps to Reproduce
 
 1. (for example) Start a new project with `wagtail start myproject`
@@ -26,12 +24,11 @@ A summary of the issue.
 
 Any other relevant information. For example, why do you consider this a bug and what did you expect to happen instead?
 
-* I have confirmed that this issue can be reproduced as described on a fresh Wagtail project: (yes / no)
-
+-   I have confirmed that this issue can be reproduced as described on a fresh Wagtail project: (yes / no)
 
 ### Technical details
 
-* 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 https://www.whatsmybrowser.org/ to find this out.
+-   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 https://www.whatsmybrowser.org/ to find this out.

+ 2 - 3
.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,17 +1,16 @@
 ---
-name: "📚 Documentation"
+name: '📚 Documentation'
 about: Suggest edits for the Wagtail documentation
 title: ''
 labels: 'Documentation'
 assignees: ''
-
 ---
 
 <!--
   Summarise the documentation change you’re suggesting in the Issue title.
 -->
 
-### Pertinent section of the Wagtail docs 
+### Pertinent section of the Wagtail docs
 
 <!--
   Copy the section link here.

+ 1 - 2
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,10 +1,9 @@
 ---
-name: "🚀 Feature request"
+name: '🚀 Feature request'
 about: Suggest an idea for improving Wagtail
 title: ''
 labels: 'type:Enhancement'
 assignees: ''
-
 ---
 
 ### Is your proposal related to a problem?

+ 2 - 13
.github/ISSUE_TEMPLATE/GSOC.md

@@ -1,28 +1,17 @@
 ---
-name: "Google Summer of Code"
+name: 'Google Summer of Code'
 about: See https://github.com/wagtail/wagtail/wiki/Google-Summer-of-Code-2022
 title: ''
 labels: 'GSOC'
 assignees: thibaudcolas, dawnwages
-
 ---
 
-## Summary 
-
-
+## Summary
 
 ## Implementation
 
-
-
 ## Skills
 
-
-
 ## Mentors
 
-
-
 ## Aims
-
-

+ 10 - 10
.github/PULL_REQUEST_TEMPLATE.md

@@ -6,17 +6,17 @@ Before submitting, please review the [contributor guidelines](https://docs.wagta
 
 _Please check the following:_
 
-- [ ] Do the tests still pass?[^1]
-- [ ] 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?[^2]
-    - [ ] **Please list the exact browser and operating system versions you tested**:
-    - [ ] **Please list which assistive technologies [^3] you tested**: 
-- [ ] For new features: Has the documentation been updated accordingly?
+-   [ ] Do the tests still pass?[^1]
+-   [ ] 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?[^2]
+    -   [ ] **Please list the exact browser and operating system versions you tested**:
+    -   [ ] **Please list which assistive technologies [^3] you tested**:
+-   [ ] For new features: Has the documentation been updated accordingly?
 
-**Please describe additional details for testing this change**. 
+**Please describe additional details for testing this change**.
 
 [^1]: [Development Testing](https://docs.wagtail.org/en/latest/contributing/developing.html#testing)
 [^2]: [Browser and device support](https://docs.wagtail.org/en/latest/contributing/developing.html#browser-and-device-support)
-[^3]: [Accessibility Target](https://docs.wagtail.org/en/latest/contributing/developing.html#accessibility-targets) 
+[^3]: [Accessibility Target](https://docs.wagtail.org/en/latest/contributing/developing.html#accessibility-targets)

+ 10 - 13
CODE_OF_CONDUCT.md

@@ -14,22 +14,19 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+-   The use of sexualized language or imagery and unwelcome sexual attention or advances
+-   Trolling, insulting/derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or electronic address, without explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

+ 0 - 2
README.md

@@ -67,7 +67,6 @@ python manage.py runserver
 
 For detailed installation and setup docs, see [the getting started tutorial](https://docs.wagtail.org/en/stable/getting_started/tutorial.html).
 
-
 ### 👨‍👩‍👧‍👦 Who’s using it?
 
 Wagtail is used by [NASA](https://www.nasa.gov/), [Google](https://www.google.com/), [Oxfam](https://www.oxfam.org/en), the [NHS](https://www.nhs.uk/), [Mozilla](https://www.mozilla.org/en-US/), [MIT](https://www.mit.edu/), the [Red Cross](https://www.icrc.org/en), [Salesforce](https://www.salesforce.com/), [NBC](https://www.nbc.com/), [BMW](https://www.bmw.com/en/index.html), and the US and UK governments. Add your own Wagtail site to [madewithwagtail.org](https://madewithwagtail.org).
@@ -82,7 +81,6 @@ For those who are **new to Wagtail**, the [Zen of Wagtail](https://docs.wagtail.
 
 **Do you have an existing Django project?** The [Wagtail Integration documentation](https://docs.wagtail.org/en/stable/getting_started/integrating_into_django.html) is the best place to start.
 
-
 ### 📌 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.org/en/stable/releases/upgrading.html#compatible-django-python-versions) in the Wagtail documentation.)_

+ 1 - 0
SECURITY.md

@@ -1,4 +1,5 @@
 # Security
+
 We take the security of Wagtail, and related packages we maintain, seriously. If you have found a security issue with any of our projects please email us at security@wagtail.org so we can work together to find and patch the issue. We appreciate responsible disclosure with any security related issues, so please contact us first before creating a Github issue.
 
 If you want to send an encrypted email (optional), the public key ID for security@wagtail.org is 0xbed227b4daf93ff9, and this public key is available from most commonly-used keyservers.

+ 31 - 31
SPONSORS.md

@@ -2,54 +2,54 @@
 
 The following organisations and individuals supported the [Wagtail's First Hatch](https://www.kickstarter.com/projects/noripyt/wagtails-first-hatch) crowdfunding campaign:
 
-- [Springload](https://springload.nz/)
-- [NetFM](https://netfm.org/)
-- [Ambient Innovation](https://ambient-innovation.com/)
-- [Shenberger Technology](http://shenbergertech.com/)
-- [Type/Code](https://typecode.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](https://www.fool.com/)
-- [R Strother Scott](https://twitter.com/rstrotherscott)
-- [Beyond Media](https://www.beyond.works/)
+-   [Springload](https://springload.nz/)
+-   [NetFM](https://netfm.org/)
+-   [Ambient Innovation](https://ambient-innovation.com/)
+-   [Shenberger Technology](http://shenbergertech.com/)
+-   [Type/Code](https://typecode.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](https://www.fool.com/)
+-   [R Strother Scott](https://twitter.com/rstrotherscott)
+-   [Beyond Media](https://www.beyond.works/)
 
 The features below were developed thanks to the sponsorship of these organsations:
 
- - Collections for images and documents - [University of South Wales](https://www.southwales.ac.uk/)
+-   Collections for images and documents - [University of South Wales](https://www.southwales.ac.uk/)
 
-- Display of revision differences - [Blackstone Chambers](https://www.blackstonechambers.com/)
+-   Display of revision differences - [Blackstone Chambers](https://www.blackstonechambers.com/)
 
-- Privacy settings on collections of documents - [Wharton Research Data Services](https://www.WhartonWRDS.com/) of [The Wharton School](https://www.wharton.upenn.edu)
+-   Privacy settings on collections of documents - [Wharton Research Data Services](https://www.WhartonWRDS.com/) of [The Wharton School](https://www.wharton.upenn.edu)
 
-- Hooks for overriding menu actions - [The Motley Fool](https://www.fool.com/)
+-   Hooks for overriding menu actions - [The Motley Fool](https://www.fool.com/)
 
-- Improved page locking - [The Motley Fool](https://www.fool.com/)
+-   Improved page locking - [The Motley Fool](https://www.fool.com/)
 
-- Exporting data from reports, form submissions and ModelAdmin  - [The Motley Fool](https://www.fool.com/)
+-   Exporting data from reports, form submissions and ModelAdmin - [The Motley Fool](https://www.fool.com/)
 
-- Moderation workflow  - [The Motley Fool](https://www.fool.com/)
+-   Moderation workflow - [The Motley Fool](https://www.fool.com/)
 
-- Complex search queries  - [The Motley Fool](https://www.fool.com/)
+-   Complex search queries - [The Motley Fool](https://www.fool.com/)
 
-- Multi-lingual content - [Torchbox](https://torchbox.com/wagtail-cms/) and [The Mozilla Foundation](https://foundation.mozilla.org/en/)
+-   Multi-lingual content - [Torchbox](https://torchbox.com/wagtail-cms/) and [The Mozilla Foundation](https://foundation.mozilla.org/en/)
 
-- Page aliases - [The Mozilla Foundation](https://foundation.mozilla.org/en/)
+-   Page aliases - [The Mozilla Foundation](https://foundation.mozilla.org/en/)
 
-- Hooks for Snippet customisation - [The Mozilla Foundation](https://foundation.mozilla.org/en/)
+-   Hooks for Snippet customisation - [The Mozilla Foundation](https://foundation.mozilla.org/en/)
 
-- Utility for testing hooks - [The Mozilla Foundation](https://foundation.mozilla.org/en/)
+-   Utility for testing hooks - [The Mozilla Foundation](https://foundation.mozilla.org/en/)
 
-- Telepath for StreamField editing - [YouGov](https://yougov.co.uk/)
+-   Telepath for StreamField editing - [YouGov](https://yougov.co.uk/)
 
-- Commenting - [The Motley Fool](https://www.fool.com/)
+-   Commenting - [The Motley Fool](https://www.fool.com/)
 
-- Automatic redirect creation - [The National Archives](https://www.nationalarchives.gov.uk)
+-   Automatic redirect creation - [The National Archives](https://www.nationalarchives.gov.uk)
 
-- Persistent IDs for ListBlock items - [NHS](https://www.nhs.uk/)
+-   Persistent IDs for ListBlock items - [NHS](https://www.nhs.uk/)
 
-- Page editor redesign - [Google](http://google.com/)
+-   Page editor redesign - [Google](http://google.com/)
 
-- StreamField rich text block splitter - [The Motley Fool](https://www.fool.com/)
+-   StreamField rich text block splitter - [The Motley Fool](https://www.fool.com/)

+ 3 - 3
client/README.md

@@ -11,7 +11,7 @@ npm install wagtail
 ```javascript
 import { Explorer } from 'wagtail';
 // [...]
-<Explorer />
+<Explorer />;
 ```
 
 ## Development
@@ -23,8 +23,8 @@ npm run start
 
 You will also need:
 
-- [React DevTools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) – React developer tools integrated into Chrome.
-- [Redux DevTools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) – Redux developer tools integrated into Chrome.
+-   [React DevTools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) – React developer tools integrated into Chrome.
+-   [Redux DevTools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) – Redux developer tools integrated into Chrome.
 
 ## Releases
 

+ 1 - 1
docs/README.md

@@ -8,7 +8,7 @@ To build the documentation for browsing, from this directory run:
 
     make html
 
-then open ``_build/html/index.html`` in a browser.
+then open `_build/html/index.html` in a browser.
 
 To rebuild automatically while editing the documentation, from this directory run: