Skip to content

Commit 212bad0

Browse files
committed
add Onboarding Assistant page
1 parent b320a00 commit 212bad0

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

publisher/guides/getting-started.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ The WordPress Podlove Podcast Publisher is a workflow-oriented solution for seri
1515

1616
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.
1717

18+
:::tip
19+
20+
There is an interactive [Onboarding Assistant](./onboarding-assistant.mdx) since Release 4.2. You can either
21+
**setup a new podcast** or **move your existing podcast to Podlove** with just
22+
your RSS Feed URL.
23+
24+
The Onboarding module is enabled by default for new setups. If you don't see the
25+
"Welcome to Podlove" banner inviting you to get started, verify in the _Modules_
26+
that **Onboarding** is enabled.
27+
28+
:::
29+
1830
<YouTube videoId="Hmrm-jUe6u4" opts={{ width: '100%' }} />
1931

2032
### Configuring Basics
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Onboarding Assistant
3+
---
4+
5+
The Onboarding Assistant Module allows you to easily set up a new podcast, or
6+
import an existing one via the RSS feed.
7+
8+
## Using the Assistant
9+
10+
The Onboarding module is enabled by default for new setups. If you don't see the
11+
"Welcome to Podlove" banner inviting you to get started, verify in the Modules
12+
that Onboarding is enabled.
13+
14+
If you plan to use the importer, it is a good idea to raise the memory limit to
15+
ensure smooth file uploads. See the troubleshooting section below for details.
16+
17+
## Troubleshooting failed Imports
18+
19+
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:
20+
21+
```php
22+
# wp-config.php
23+
24+
define( 'WP_DEBUG', true );
25+
// Enable Debug logging to the /wp-content/debug.log file
26+
define( 'WP_DEBUG_LOG', true );
27+
// Disable display of errors and warnings
28+
define( 'WP_DEBUG_DISPLAY', false );
29+
@ini_set( 'display_errors', 0 );
30+
```
31+
32+
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:
33+
34+
```php
35+
# wp-config.php
36+
37+
define( 'WP_MEMORY_LIMIT', '512M' );
38+
```
39+
40+
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:
41+
42+
```php
43+
# wp-config.php
44+
45+
set_time_limit(300);
46+
```
47+
48+
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.
49+
50+
## Publishing imported Episodes
51+
52+
Episodes are imported as _private_ so you have a chance to verify them before they are published.
53+
54+
To publish all at once, use the _Bulk actions_ feature on the episodes page:
55+
56+
- In the "Screen Options", increase the "Number of items per page" to at least
57+
the total number of episodes.
58+
- Click the top checkbox in the episodes table to select all episodes at once.
59+
- In the "Bulk actions", select "Edit", then click "Apply"
60+
- In the appearing modal, find the "Status" selector and choose "Published"
61+
- Click "Update"

publisher/sidebar.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ module.exports = [
99
label: "Guides",
1010
items: [
1111
"guides/getting-started",
12+
"guides/onboarding-assistant",
1213
"guides/podcast-network",
1314
"guides/templates",
1415
"guides/api-usage"

0 commit comments

Comments
 (0)