From 212bad0b4b2af7ac747bf1efb37fe3b3d5701372 Mon Sep 17 00:00:00 2001 From: Eric Teubert Date: Sun, 5 Jan 2025 12:12:47 +0800 Subject: [PATCH] add Onboarding Assistant page --- publisher/guides/getting-started.mdx | 12 +++++ publisher/guides/onboarding-assistant.mdx | 61 +++++++++++++++++++++++ publisher/sidebar.js | 1 + 3 files changed, 74 insertions(+) create mode 100644 publisher/guides/onboarding-assistant.mdx diff --git a/publisher/guides/getting-started.mdx b/publisher/guides/getting-started.mdx index 1f182c88..1eb65b52 100644 --- a/publisher/guides/getting-started.mdx +++ b/publisher/guides/getting-started.mdx @@ -15,6 +15,18 @@ The WordPress Podlove Podcast Publisher is a workflow-oriented solution for seri You need [WordPress][1] running on your web server. Download the [Podlove Podcast Publisher][2] plugin, unzip it, put it into the WordPress plugin directory, and activate it. If you are new to WordPress, you may find the [Installing Plugins][3] instructions helpful. +:::tip + +There is an interactive [Onboarding Assistant](./onboarding-assistant.mdx) since Release 4.2. You can either +**setup a new podcast** or **move your existing podcast to Podlove** with just +your RSS Feed URL. + +The Onboarding module is enabled by default for new setups. If you don't see the +"Welcome to Podlove" banner inviting you to get started, verify in the _Modules_ +that **Onboarding** is enabled. + +::: + ### Configuring Basics diff --git a/publisher/guides/onboarding-assistant.mdx b/publisher/guides/onboarding-assistant.mdx new file mode 100644 index 00000000..68dccb61 --- /dev/null +++ b/publisher/guides/onboarding-assistant.mdx @@ -0,0 +1,61 @@ +--- +title: Onboarding Assistant +--- + +The Onboarding Assistant Module allows you to easily set up a new podcast, or +import an existing one via the RSS feed. + +## Using the Assistant + +The Onboarding module is enabled by default for new setups. If you don't see the +"Welcome to Podlove" banner inviting you to get started, verify in the Modules +that Onboarding is enabled. + +If you plan to use the importer, it is a good idea to raise the memory limit to +ensure smooth file uploads. See the troubleshooting section below for details. + +## Troubleshooting failed Imports + +If some episodes are not importing correctly, the best way to find out why is to look into your WordPress logs. You may need to turn it on manually, see [Debugging in WordPress](https://developer.wordpress.org/advanced-administration/debug/debug-wordpress/#example-wp-config-php-for-debugging). You likely want this: + +```php +# wp-config.php + +define( 'WP_DEBUG', true ); +// Enable Debug logging to the /wp-content/debug.log file +define( 'WP_DEBUG_LOG', true ); +// Disable display of errors and warnings +define( 'WP_DEBUG_DISPLAY', false ); +@ini_set( 'display_errors', 0 ); +``` + +When uploading the audio file, your WordPress needs to be able to hold the whole file in RAM before saving it. Some files may be too large for default configurations. The workaround is: + +```php +# wp-config.php + +define( 'WP_MEMORY_LIMIT', '512M' ); +``` + +Another issue that may occur during file upload is running out of time. Usually the limit is about 30 seconds and you may need to contact your host to increase the limit. But you can try to increase it like this: + +```php +# wp-config.php + +set_time_limit(300); +``` + +If despite these workarounds you still need help, feel free to open a thread in the [forums](https://community.podlove.org/c/podlove-publisher/6). Please include relevant entries from the error log in your post, otherwise we will probably not be able to help. + +## Publishing imported Episodes + +Episodes are imported as _private_ so you have a chance to verify them before they are published. + +To publish all at once, use the _Bulk actions_ feature on the episodes page: + +- In the "Screen Options", increase the "Number of items per page" to at least + the total number of episodes. +- Click the top checkbox in the episodes table to select all episodes at once. +- In the "Bulk actions", select "Edit", then click "Apply" +- In the appearing modal, find the "Status" selector and choose "Published" +- Click "Update" diff --git a/publisher/sidebar.js b/publisher/sidebar.js index b13238b9..058a2468 100644 --- a/publisher/sidebar.js +++ b/publisher/sidebar.js @@ -9,6 +9,7 @@ module.exports = [ label: "Guides", items: [ "guides/getting-started", + "guides/onboarding-assistant", "guides/podcast-network", "guides/templates", "guides/api-usage"