• This plugin was working for about a year (after a painful setup process), then suddenly stopped working. The documentation is written assuming that it will just work but is missing many crucial details. It is supposed to be wizard-driven, but the wizard often gets stuck on the last step. The log file is not generated even with the setting turned on (and it will revert to disabled when refreshing the page). In short, troubleshooting this plugin is a nightmare and not worth the time.

    • This topic was modified 3 years, 11 months ago by Mike.
Viewing 4 replies - 1 through 4 (of 4 total)
  • Plugin Contributor iSaumya

    (@isaumya)

    Hi,
    in the countless sites that I have and with many other people who have set up the plugin, I have never faced such a problem. Moreover, if you are facing any issues, please feel free to open a support thread where it can be further looked at and help can be given.

    The plugin is very well documented both in the wp.org plugin description section and also under the FAQ tab of the plugin settings.

    The documentation is written assuming that it will just work but is missing many crucial details

    – Can you please clarify – what crucial details are missing?

    It is supposed to be wizard-driven, but the wizard often gets stuck on the last step. The log file is not generated even with the setting turned on (and it will revert to disabled when refreshing the page).

    – I honestly don’t see how that is possible. If you have enabled the log mode and set the Log Verbosity to HIGH in the plugin settings, it will just log every step that you take in the plugin.

    There is just no way that the plugin will suddenly stop working. Anyways, if you want you can open a thread in the support thread section – if you are looking for help.

    P.S.: You have also mentioned horrible support. First of all, it’s a free plugin moreover can you share the links of the threads that you have opened where you have received “horrible” support?

    • This reply was modified 3 years, 11 months ago by iSaumya.
    Thread Starter Mike

    (@mromp2103)

    I’m sorry, but a cherry-picked FAQ is not a replacement for proper documentation. And despite your experience, everything I stated is happening for something that was working perfectly. Log verbosity is high and logging on, but there is no log file and no error. The “documentation” doesn’t even mention logging or where to find the log file. For what it’s worth, in this state, clicking “Download Log File” simply goes to the WP dashboard and no log file is delivered (because it doesn’t exist).

    I also imagine most of your setups involve the much less secure API key rather than a token with specific rights, which is where most of the challenges occurred when first setting it up. On that note, nowhere in the “documentation” does it even list the API token settings — you need to dig into forum posts to even find it.

    Your point on support for a free product is valid and I apologize. I was hasty and frustrated with the lack of documentation and reacting to certain responses others had received. Regardless, I have moved on from this plugin and wish you the best.

    Plugin Contributor iSaumya

    (@isaumya)

    Inside the plugin settings page when you select API token it clearly shows you the list of permissions you need to provide to the token.

    Regarding log files not getting created – the only way it is possible is if you have disabled the ability of the PHP to create and modify files or improper permissions.

    Wish you all the best as well.

    Thread Starter Mike

    (@mromp2103)

    I did not intend to turn this into a support thread as I no longer need this plugin and have noticed no real difference in page load times since disabling it. I only wanted to suggest that you create proper documentation and possibly better error handling, and to warn others that anything other than a cookie-cutter setup may be difficult to troubleshoot.

    If PHP is unable to access a file, then there should be a clear error message stating as much (there is none whatsoever). Although it this case, it was able to delete the file just fine with the “Clear Logs Now” button. Before doing so, its last entry was from 2021 so it was working at some point.

    And I’m sorry, but there is no list of API permissions on the plugin settings page. See here. I vaguely remember better information in the first few pages of the wizard when I first set it up over a year ago, but once you have gone through that, it is stuck on the third page. Regardless, that doesn’t change the argument that this information belongs in the documentation, which again doesn’t really exist.

Viewing 4 replies - 1 through 4 (of 4 total)

The topic ‘Plugin Does Not Work – Insufficient Documentation’ is closed to new replies.