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.

Sign up for GitHub

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

Jump to bottom

WIP - Add Ensign for Data Engineers Page #140

Merged
merged 9 commits into from Feb 3, 2023
Merged

WIP - Add Ensign for Data Engineers Page #140

merged 9 commits into from Feb 3, 2023

Conversation

pdamodaran
Copy link
Contributor

@pdamodaran pdamodaran commented Jan 31, 2023 •
edited

Scope of changes

I have added documentation on how to use Ensign and Watermill to pull data from a Weather API and load into a PostgreSQL database.

There are a few TODOs

  • The code currently works without an Ensign API Key. I need to update the code and documentation to use an Ensign API Key.
  • I need write access to ensign-examples so that I can add the code there update the full code link in the documentation.
  • I have two png files that are not rendering. They are currently under docs/examples. I need to move them to the appropriate location.
  • I need write access to watermill-ensign so that I can add a code example.

Fixes SC-12538

Type of change

  • new feature
  • bug fix
  • documentation
  • testing
  • technical debt
  • other (describe)

Acceptance criteria

Describe how reviewers can test this change to be sure that it works correctly. Add a checklist if possible.

Author checklist

  • I have manually tested the change and/or added automation in the form of unit tests or integration tests
  • I have updated the dependencies list
  • I have recompiled and included new protocol buffers to reflect changes I made
  • I have added new test fixtures as needed to support added tests
  • Check this box if a reviewer can merge this pull request after approval (leave it unchecked if you want to do it yourself)
  • I have moved the associated Shortcut story to "Ready for Review"

Reviewer(s) checklist

  • Any new user-facing content that has been added for this PR has been QA'ed to ensure correct grammar, spelling, and understandability.
  • Are there any TODOs in this PR that should be turned into stories?

@shortcut-integration
Copy link

This pull request has been linked to Shortcut Story #12538: Create E2E tutorial for Ensign MVP Data Engineer user.

@rebeccabilbro
Copy link
Member

@pdamodaran just gave you access to those repos!

@rebeccabilbro rebeccabilbro self-requested a review January 31, 2023 20:25
@pdamodaran
Copy link
Contributor Author

I have made the following changes:

  • Added client id and client secret to the code
  • I created an img directory under static and moved the images there and verified that the images are rendering now
  • I have pushed my code example to ensign-examples and watermill-ensign. PRs here and here.

pdamodaran
pdamodaran commented Feb 1, 2023
View reviewed changes
docs/content/examples/data_engineers.md Outdated
Hi there! This tutorial is targeted towards Golang data engineers. If you are interested in or currently writing event-driven applications in Go you are in the right place! In this code-driven tutorial we will use the [Watermill-Ensign](https://github.com/rotationalio/watermill-ensign) Golang SDK and [Watermill](https://watermill.io) to call a Weather API and insert the weather information into a PostgreSQL database. For those who are not familiar with Watermill, refer to my [initial post](https://rotational.io/blog/prototyping-eda-with-watermill/).

TODO: change this link
If you came here for the code the full example is available [here](https://github.com/rotationalio/ensign-examples/tree/main/go/tweets).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we can change this link once the code example is merged into main.

@masskoder masskoder changed the title [WIP] - Add Ensign for Data Engineers Page Add Ensign for Data Engineers Page Feb 1, 2023
@masskoder masskoder changed the title Add Ensign for Data Engineers Page WIp - Add Ensign for Data Engineers Page Feb 1, 2023
@masskoder masskoder changed the title WIp - Add Ensign for Data Engineers Page WIP - Add Ensign for Data Engineers Page Feb 1, 2023
rebeccabilbro
rebeccabilbro approved these changes Feb 3, 2023
View reviewed changes
Copy link
Member

@rebeccabilbro rebeccabilbro left a comment

Choose a reason for hiding this comment

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

Great work @pdamodaran !
I particularly love the PostgreSQL tie-in — such a good way to illustrate how Ensign puts data in motion!

@rebeccabilbro rebeccabilbro merged commit 06e2ac9 into main Feb 3, 2023
@rebeccabilbro rebeccabilbro deleted the sc-12538 branch February 3, 2023 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rebeccabilbro rebeccabilbro rebeccabilbro approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@pdamodaran @rebeccabilbro