yonkov/custom-welcome-guide

Customize the Welcome Guide message that pops up when the user opens up the Block editor for the first time.

custom-welcome-guide's Issues

Create Plugin Logo

Replace default Welcome Guide Popup with a Custom one

By selecting a "featured" tour from the plugin's settings page, users should override the default Welcome Guide modal that pops up in the Gutenberg Editor.

Acceptance criteria: The featured tour should pop up when you open the editor for the first time

Useful links:

1. WordPress/gutenberg#19512
2. https://wordpress.org/plugins/disable-welcome-messages-and-tips/
3. Building custom Welcome modal in Wordpress: https://css-tricks.com/adding-a-custom-welcome-guide-to-the-wordpress-block-editor/

Display the Featured Guide in the Whole WordPress Admin

Currently the featured guide is displayed in the Block editor only. Enable it on all admin pages.

Plugin's Settings page: Save Notification not Showing in WordPress 5.5

Change Plugin name to "Custom Welcome Guide" and update plugin description

Hide Guides CPT on the Site Frontend

Thoroughly Test The Plugin

Testing criteria:

• test with different wp versions
• test without guides
• test with different content when creating a Guide.
• try creating only one guide without subguides
• try creating only one guide with many subguides
• try creating many guides without subguides
• try creating many guides with many subguides
• try creating guides with featured images
• try adding malicious js to the content of the guide
• check documentation and update if necessary

Success criteria:

• everything works as expected
• no php notices when wp_debug set to true
• no js notices and errors

Plugin does not work when the Classic Editor Plugin is enabled

Problem: The plugin is currently not compatible with the classic WordPress editor. A possible workaround would be to display a notice for users who are still using the Classic Editor to switch to the Gutenberg Editor in order to use the plugin.

** Useful links:**

1. https://www.wpbeginner.com/wp-tutorials/how-to-add-admin-notices-in-wordpress/
2. WordPress/gutenberg#12200

Success criteria: A dismissable php notice on top of the post editor would suffice.

Add Additional Tab in the Plugin's Settings page to change the Guide's color palette.

We should use the Color Picker Gutenberg Component to accomplish this.

When a Featured guide is set to None, hide the "show the featured guide in the whole admin" button

A small change is required on plugin options page. The last option, "show the featured guide in the whole admin" should be visible only when featured guide is not set to "None".

Create a Loading Component

When the posts are fetched, for a brief period of time, they are undefined. Maybe we can add a spinner to indicate that data has been loaded, for a better user experience.

Priority: low

Create Custom Plugin Settings Page using React

Add options to the plugin settings page:

1. show welcome guides in Posts (checkbox enabled by default)
2. show welcome guides in Pages (checkbox enabled by default)
3. show welcome guides in Custom Post Types (checkbox disabled by default)

Fix Css for the popup and for the guide list.

Test backwards compatibility with WordPress 5.4 and PHP 5.6

Display a dynamic list of all user guides in the guide-list template. Link each guide to the correct steps that correspond to it.

The guide component is now dynamic. However, we also need to make the buttons that trigger the guides in the Gutenberg post sidebar dynamic too. Also, each button should trigger the correct steps that are connected to the corresponding guide. (currently the guide list is hardcoded in guide-list.js and they all just show all available guides):