Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added "Recommended Content" Block #343

Merged
merged 68 commits into from
Sep 2, 2022
Merged

Added "Recommended Content" Block #343

merged 68 commits into from
Sep 2, 2022

Conversation

iamdharmesh
Copy link
Member

@iamdharmesh iamdharmesh commented May 11, 2022

Description of the Change

This PR Adds the Initial "Recommended Content" Block backed by the Azure Personalizer. Major changes of PR are listed below.

  • Added @wordpress/scripts
  • Format js and fixed reported eslint errors.
  • Integration with Azure Personalizer API.
  • Added "Recommended Content" Block.

Note: This is yet initial implementation based on personalizer documentation and we may still have to check on the below stuff to close #69

  • Include User location data in contextFeatures for better personalization.
  • Currently, block only suggest 1 recommended content as personalizer only return 1 rewarded action. We should check on the possibility/workaround to display multiple contents. (We are showing multiple items now, as decided in internal slack discussion)
  • Define suggested configuration to make the plugin work more effectively (config like model update frequency, reward wait time, etc...).
  • Verify content personalization with huge content and different use cases

Some Useful links for Azure Personalizer:

Screenshots

Personalizer Settings:

image

Recommended Content Block:

image

Closes #69

Alternate Designs

We may choose any other recommended content service, other than Azure Personalizer.

Possible Drawbacks

Not identified any.

Verification Process

  1. Save Azure Personalizer settings.
  2. Verify it gets authenticated and saved. (wrong key we should show error on save)
  3. Add "Recommended Content" Block
  4. Verify Filters and various setting options work properly.
  5. Verify Block content displays properly in front-end and send the reward to azure on click-on content.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Changelog Entry

Added: Initial "Recommended Content" Block

Credits

Props @iamdharmesh @jeffpaul @Sidsector9

@iamdharmesh iamdharmesh self-assigned this May 11, 2022
@jeffpaul jeffpaul modified the milestones: 1.8.0, 2.0.0 May 13, 2022
@iamdharmesh
Copy link
Member Author

Thanks for the review @dkotter, I am made some minor improvements and resolved conflicts.

Also, I think still needing updates to our readme around this new feature and how to get it set up. I think you may be waiting on something from @jeffpaul, at least according to #343 (comment).

I have updated readme based on docs available online, maybe @jeffpaul can help to verify it once.

Do you think we should release this feature as Alpha/Beta for now by adding notice somewhere? also, We have some further stuff (mentioned in PR description) to work on it once this get merged.

Thanks.

@iamdharmesh iamdharmesh requested a review from dkotter July 29, 2022 13:44
dkotter
dkotter previously approved these changes Aug 5, 2022
@dkotter
Copy link
Collaborator

dkotter commented Aug 5, 2022

I think this is good to go as a first version of this.

Do you think we should release this feature as Alpha/Beta for now by adding notice somewhere

We could note this in the README, that this is a feature that we're still gathering feedback on, but not sure if that's critical

@jeffpaul jeffpaul self-requested a review August 31, 2022 02:28
@jeffpaul
Copy link
Member

@iamdharmesh I just did a first though thorough pass on copy and such, but would love to test this out a bit more closely. Mind spinning this PR out into a test site for me to see if there are other places to tweak the UX/copy/etc?

Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some tweaks to copy throughout and added a screenshot and content to the readme, all minor changes and otherwise this looks great. Fantastic work @iamdharmesh!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integrate Azure Personalizer for personalized content
4 participants