Преглед на файлове

Update docs for renaming publish_scheduled_pages command to publish_scheduled

Sage Abdullah преди 2 години
родител
ревизия
48761ef5a9
променени са 4 файла, в които са добавени 13 реда и са изтрити 8 реда
  1. 2 2
      docs/extending/audit_log.md
  2. 9 4
      docs/reference/management_commands.md
  3. 1 1
      docs/reference/pages/theory.md
  4. 1 1
      docs/releases/0.4.rst

+ 2 - 2
docs/extending/audit_log.md

@@ -65,10 +65,10 @@ The `log` function was added. Previously, logging was only implemented for pages
 | `wagtail.delete`                  | The object was deleted. Will only surface in the Site History for administrators |
 | `wagtail.publish`                 | The page was published                                                           |
 | `wagtail.publish.schedule`        | Draft is scheduled for publishing                                                |
-| `wagtail.publish.scheduled`       | Draft published via `publish_scheduled_pages` management command                 |
+| `wagtail.publish.scheduled`       | Draft published via `publish_scheduled` management command                       |
 | `wagtail.schedule.cancel`         | Draft scheduled for publishing cancelled via "Cancel scheduled publish"          |
 | `wagtail.unpublish`               | The page was unpublished                                                         |
-| `wagtail.unpublish.scheduled`     | Page unpublished via `publish_scheduled_pages` management command                |
+| `wagtail.unpublish.scheduled`     | Page unpublished via `publish_scheduled` management command                      |
 | `wagtail.lock`                    | Page was locked                                                                  |
 | `wagtail.unlock`                  | Page was unlocked                                                                |
 | `wagtail.moderation.approve`      | The revision was approved for moderation                                         |

+ 9 - 4
docs/reference/management_commands.md

@@ -2,15 +2,20 @@
 
 # Management commands
 
-(publish_scheduled_pages)=
+(publish_scheduled)=
 
-## publish_scheduled_pages
+## publish_scheduled
+
+```{versionchanged} 4.1
+This command has been renamed from `publish_scheduled_pages` to `publish_scheduled` and it now also handles non-page objects.
+The `publish_scheduled_pages` command is still available as an alias, but it is recommended to update your configuration to run the `publish_scheduled` command instead.
+```
 
 ```console
-$ ./manage.py publish_scheduled_pages
+$ ./manage.py publish_scheduled
 ```
 
-This command publishes, updates or unpublishes pages that have had these actions scheduled by an editor. We recommend running this command once an hour.
+This command publishes, updates or unpublishes objects that have had these actions scheduled by an editor. We recommend running this command once an hour.
 
 (fixtree)=
 

+ 1 - 1
docs/reference/pages/theory.md

@@ -92,7 +92,7 @@ You can apply custom behaviour to this process by overriding `Page` class method
 ## Scheduled Publishing
 
 Page publishing can be scheduled through the _Go live date/time_ feature in the _Settings_ tab of the _Edit_ page. This allows you to set set up initial page publishing or a page update in advance.
-In order for pages to be published at the scheduled time you should set up the [publish_scheduled_pages](publish_scheduled_pages) management command.
+In order for pages to be published at the scheduled time you should set up the [publish_scheduled](publish_scheduled) management command.
 
 The basic workflow is as follows:
 

+ 1 - 1
docs/releases/0.4.rst

@@ -32,7 +32,7 @@ Scheduled publishing
 
 Editors can now schedule pages to be published or unpublished at specified times.
 
-A new management command has been added (:ref:`publish_scheduled_pages`) to publish pages that have been scheduled by an editor.
+A new management command has been added (:ref:`publish_scheduled_pages <publish_scheduled>`) to publish pages that have been scheduled by an editor.
 
 
 Search on QuerySet with Elasticsearch