Skip to content

Create a component for the MyYoast connection #12133

@herregroen

Description

@herregroen

A new component should be added where users can see the status of the connection between MyYoast and their site.

This component will be used in the configuration wizard and on the premium page.

In all cases taking action here will redirect the user to MyYoast.

In the premium page this component should be at the top and once the user is done in MyYoast will be send back to the premium page.

In the configuration wizard this will be a separate step and once the user is done in MyYoast they will be send back to the same step ( where they should be able to see that it's been completed ).

This component can have 4 possible states:

  1. Use case: I've just installed premium and am following the configuration wizard to configure my plugin. I've never heard about connecting to MyYoast before. I should have a button available to start connecting.
    Technical: No configuration is saved. There should be a CTA to connect your site to MyYoast and some text giving a short explanation of what this entails. The CTA should call the prepare route outlined in Add prepare route for MyYoast connection #12131.
  2. Use case: I, or another user on my site, has previously started an attempt to connect to MyYoast but never finished for whatever reason. It's possible I'm seeing this for the first time but another user is currently setting this up in which case me starting as well would cause the other user's attempt to fail. It's also possible I started it myself but my PC crashed and I want to finish it now. I should have a button available to start connecting.
    Technical: Only a client ID is saved. This means that either the site is currently being connected ( possibly by another user ) or the connection has failed. There should be a CTA to retry the connection which should likewise call the prepare route outlined in Add prepare route for MyYoast connection #12131.
  3. Use case: I've previously set up a connection to MyYoast and it has been working without issue. But it's not been used at all for a significant amount of time so I need to log in again to re-enable it, permission will not need to be granted again. I should have a button available allowing me to login again.
    Technical: Both a client ID and client secret are saved but no access token. This means that the connection has been setup but either an access token was never retrieved or has been somehow invalidated. There should be a CTA for the user to log into MyYoast again using the authorize route outlined in Add authorize route for MyYoast connection #12132.
  4. Use case: I've previously set up a connection to MyYoast and it has been working without issue. I should have some non-emphasized way of undoing the connection.
    Technical: A client ID, client secret and access token are all present. The connection is fully functional. A possible CTA may be available to disconnect from MyYoast.

parent #12136
needs #12093

Please branch from and merge into feature/oauth-connection-ui

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions