Explorar el Código

Correct LF vs CRLF instruction in Windows development docs (#11848)

Sage Abdullah hace 11 meses
padre
commit
e653a4afbb
Se han modificado 3 ficheros con 3 adiciones y 2 borrados
  1. 1 0
      CHANGELOG.txt
  2. 1 2
      docs/contributing/developing.md
  3. 1 0
      docs/releases/6.1.md

+ 1 - 0
CHANGELOG.txt

@@ -55,6 +55,7 @@ Changelog
  * Docs: Document risk of XSS attacks on document upload (Matt Westcott, with thanks to Georgios Roumeliotis of TwelveSec for the original report)
  * Docs: Add clarity to how custom StreamField validation works (Tibor Leupold)
  * Docs: Add additional reference to the `wagtail_update_image_renditions` management command on the using images page (LB (Ben) Johnston)
+ * Docs: Correct information about line endings in Window development docs (Sage Abdullah)
  * Maintenance: Move RichText HTML whitelist parser to use the faster, built in `html.parser` (Jake Howard)
  * Maintenance: Remove duplicate 'path' in default_exclude_fields_in_copy (Ramchandra Shahi Thakuri)
  * Maintenance: Update unit tests to always use the faster, built in `html.parser` & remove `html5lib` dependency (Jake Howard)

+ 1 - 2
docs/contributing/developing.md

@@ -62,10 +62,9 @@ If you are confident with Python and Node development on Windows and wish to pro
 
 We recommend [Chocolatey](https://chocolatey.org/install) for managing packages in Windows. Once Chocolatey is installed you can then install the [`make`](https://community.chocolatey.org/packages/make) utility in order to run common build and development commands.
 
-To effectively collaborate with other developers on different operating systems, we use CRLF to handle our line endings. You can configure this in Git using:
+We use LF for our line endings. To effectively collaborate with other developers on different operating systems, use Git's automatic CRLF handling by setting the `core.autocrlf` config to `true`:
 
 ```doscon
-#  Configures how Git handles line endings and sets the value to True
 git config --global core.autocrlf true
 ```
 

+ 1 - 0
docs/releases/6.1.md

@@ -74,6 +74,7 @@ depth: 1
  * Document risk of XSS attacks on document upload (Matt Westcott, with thanks to Georgios Roumeliotis of TwelveSec for the original report)
  * Add clarity to how custom [StreamField validation](streamfield_validation) works (Tibor Leupold)
  * Add additional reference to the [`wagtail_update_image_renditions`](wagtail_update_image_renditions) management command on the [using images](regenerate_image_renditions) page (LB (Ben) Johnston)
+ * Correct information about line endings in Window development docs (Sage Abdullah)
 
 
 ### Maintenance