Skip to content

Commit

Permalink
add Onboarding Assistant page
Browse files Browse the repository at this point in the history
  • Loading branch information
eteubert committed Jan 5, 2025
1 parent b320a00 commit 212bad0
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 0 deletions.
12 changes: 12 additions & 0 deletions publisher/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

<YouTube videoId="Hmrm-jUe6u4" opts={{ width: '100%' }} />

### Configuring Basics
Expand Down
61 changes: 61 additions & 0 deletions publisher/guides/onboarding-assistant.mdx
Original file line number Diff line number Diff line change
@@ -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"
1 change: 1 addition & 0 deletions publisher/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ module.exports = [
label: "Guides",
items: [
"guides/getting-started",
"guides/onboarding-assistant",
"guides/podcast-network",
"guides/templates",
"guides/api-usage"
Expand Down

0 comments on commit 212bad0

Please sign in to comment.