Automattic / Automattic/jetpack
Enhancement: Prompt Cloudflare Users to Read Jetpack Integration Documents on Plugin Activation
- Dominant language
- PHP
- Stars
- 1.8k
- Forks
- 898
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 774
Description
### Impacted plugin
Boost
### What
Detect Cloudflare to Direct People to CF integration docs before they contact you
### How
While dealing with an issue of my own via your Jetpack Boost WordPress support page, I was given the links to two different documents relating to getting Cloudflare and Jetpack to integrate.
Instead of your team having to quote this to any/every customer, once a person has one of your plugins activated, can you
1. On Plugin activation, Detect Cloudflare ( one way is to find the plugin, another might be a DNS search for Cloudflare nameservers etc). There are probably other ways too.
2. Provide the links to those documents (I was given [this one](https://jetpack.com/support/getting-started-with-jetpack/configure-jetpack-cloudflare/) and [this one](https://developers.cloudflare.com/support/third-party-software/content-management-system-cms/wordpress-jetpack-and-cloudflare/))
3. Put this in via WordPress' dashboard notification system maybe with a checkbox or confirmation button to say they have done what those documents say.
I just reckon I could have provided more to the JetPack team in terms of what I have done to try to resolve the issue if I'd been told about those documents first. So it may save your team some time, some repetition and maybe reduce some of the "it's broken, but I've done nothing to find out why" requests.
**Reference:** [https://wordpress.org/support/topic/error-log-full-of-jp-boost-errors/#post-18601240](https://wordpress.org/support/topic/error-log-full-of-jp-boost-errors/#post-18601240)
Contributor guide
Research direction
Start by reviewing the Boost plugin activation flow and WordPress dashboard notification APIs, then read the two linked Cloudflare integration documents. Done means Cloudflare users are detected on activation, shown both links, and given a way to confirm or dismiss the notification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100