Bläddra i källkod

docs: update contributing/developing.md guidelines (#11408)

Fixes #11399

Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
nikhilkalburgi 1 år sedan
förälder
incheckning
4f24171b3b
4 ändrade filer med 11 tillägg och 1 borttagningar
  1. 1 0
      CHANGELOG.txt
  2. 1 0
      CONTRIBUTORS.md
  3. 8 1
      docs/contributing/developing.md
  4. 1 0
      docs/releases/6.0.md

+ 1 - 0
CHANGELOG.txt

@@ -56,6 +56,7 @@ Changelog
  * Docs: Add section to testing docs about creating pages and working with page content (Mariana Bedran Lesche)
  * Docs: Add more nuance to the database recommendations in performance page (Jadesola Kareem)
  * Docs: Add clarity that MultipleChooserPanel may require a chooser viewset and how the functionality is expected to work (Andy Chosak)
+ * Docs: Clarify where documentation build commands should be run (nikhilkalburgi)
  * Maintenance: Update BeautifulSoup upper bound to 4.12.x (scott-8)
  * Maintenance: Migrate initialization of classes (such as `body.ready`) from multiple JavaScript implementations to one Stimulus controller `w-init` (Chiemezuo Akujobi)
  * Maintenance: Adopt the usage of of translate string literals using `arg=_('...')` in all `wagtailadmin` module templates (Chiemezuo Akujobi)

+ 1 - 0
CONTRIBUTORS.md

@@ -777,6 +777,7 @@
 * Felipe Lobato
 * Nandini Arora
 * Sai Srikar Dumpeti
+* nikhilkalburgi
 
 ## Translators
 

+ 8 - 1
docs/contributing/developing.md

@@ -289,7 +289,8 @@ The last command will start Storybook at `http://localhost:6006/`. It will proxy
 The Wagtail documentation is built by Sphinx. To install Sphinx and compile the documentation, run:
 
 ```sh
-cd /path/to/wagtail
+# Starting from the wagtail root directory:
+
 # Install the documentation dependencies
 pip install -e .[docs]
 # or if using zsh as your shell:
@@ -305,6 +306,8 @@ Python comes with a module that makes it very easy to preview static files in a
 To start this simple server, run the following commands:
 
 ```sh
+# Starting from the wagtail root directory:
+
 cd docs/_build/html/
 python -m http.server 8080
 ```
@@ -316,6 +319,8 @@ Unfortunately, this cache also hides any warnings thrown by unmodified documenta
 To clear the built HTML and start fresh, so you can see all warnings thrown when building the documentation, run:
 
 ```sh
+# Starting from the wagtail root directory:
+
 cd docs/
 make clean
 make html
@@ -325,6 +330,8 @@ Wagtail also provides a way for documentation to be compiled automatically on ea
 To do this, you can run the following command to see the changes automatically at `localhost:4000`:
 
 ```sh
+# Starting from the wagtail root directory:
+
 cd docs/
 make livehtml
 ```

+ 1 - 0
docs/releases/6.0.md

@@ -85,6 +85,7 @@ The admin interface now supports right-to-left languages, such as Persian, Arabi
  * Add section to [testing docs](../advanced_topics/testing) about creating pages and working with page content (Mariana Bedran Lesche)
  * Add more nuance to the database recommendations in [](performance_overview) (Jadesola Kareem)
  * Add clarity that [`MultipleChooserPanel`](multiple_chooser_panel) may require a chooser viewset and how the functionality is expected to work (Andy Chosak)
+ * Clarify where documentation build commands should be run (nikhilkalburgi)
 
 ### Maintenance