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

Update the examples for current version of Stream, simplify example, and add more docs #3

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

benlk
Copy link

@benlk benlk commented May 9, 2023

What this does

  • Updates the example connector to support Stream version 3.x: new namespace, make things not-static
  • Removes the post-generator example code, and simplifies the example connector. The example connector now logs when odd-numbered posts are edited.
  • Adds large amounts of in-code documentation to explain the "magic" parts of the Connector class.
  • Expands the readme with images and explanations of the concepts that are reflected in the code

Things you may want to edit before merging

  • The author, author URI, and contributors sections of readme.txt, readme.md, and stream-connector-example.php: I added credits for me and for 10up. 10up is my employer and subsidized this work.

Other recommendations

@jeffpaul
Copy link

@lukecarbis @ccmoralesj any chance of getting this through review to help update the example code in this repo?

Copy link

@lukecarbis lukecarbis left a comment

Choose a reason for hiding this comment

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

lgtm!

connectors/example.php Outdated Show resolved Hide resolved
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.

3 participants