Add troubleshooting section

This commit is contained in:
Cooper Dalrymple
2025-12-04 11:20:12 -06:00
parent b29aa40c38
commit 4db155a95f

View File

@@ -112,6 +112,24 @@ class Settings {
['name' => 'token'] ['name' => 'token']
); );
add_settings_section(
'help',
Plugin::__('Troubleshooting'),
function () {
?>
<p><strong><em>Is the API no longer working for you? Are your embeds left spinning?</em></strong><br>Don't fret, there is likely an easy solution to your woes.</p>
<ol>
<li>Let's start by checking your browser's console. Visit a page with an embed which isn't loading then follow this guide: <a href="https://appuals.com/open-browser-console/" target="_blank">https://appuals.com/open-browser-console/</a>. If the console reports something along the lines of "Bad request", then there is likely an issue with your Issuu API v2 authorization. Proceed to the next step.</li>
<li>Log in to your Issuu account and access the API tab within your Account settings: <a href="https://issuu.com/home/settings/apicredentials" target="_blank">https://issuu.com/home/settings/apicredentials</a>. If you see an API client that has expired, then you'll definitely need to create a new API client!</li>
<li>Follow the steps outlined on <a href="https://help.issuu.com/hc/en-us/articles/23059561681563-Issuu-API-v2-Getting-Started" target="_blank">Issuu's help guide</a> to create a new API client. You may want to delete the old one while you're at it.</li>
<li>Once you're all done there, copy over all three credentials (Client ID, Client Secret, and Token) to the fields on this page (Settings -> OgreIssuu) under "API Settings" and hit "Save Changes".</li>
<li>Now go back to your website and review the Issuu embeds. If they are working again, you're all good to go! If not, you may need to get in touch with your <a href="https://cleverogre.com/" target="_blank">website developer</a> to investigate further.</li>
</ol>
<?php
},
$this->get_menu_slug()
);
} }
public function the_field(array $args):void { public function the_field(array $args):void {