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

Tutorial #61

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Tutorial #61

wants to merge 11 commits into from

Conversation

susanxiong
Copy link
Contributor

After hearing feedback from multiple folks about challenges getting started with earthmover, I put together this "earthmover 101" level tutorial. We have great existing documentation for folks who already know a little about earthmover, but nothing for someone starting completely from scratch. This is meant to be for someone who has never touched earthmover before, and needs to learn the different components and how to run it. This is a work in progress and should be updated with each new person who goes through it.

@johncmerfeld
Copy link
Contributor

Haven't fully dived into this, but just wanted to say I think it's a great idea, and am wondering if we should try to integrate it somehow with this earthmover init feature?

@johncmerfeld
Copy link
Contributor

Haven't fully dived into this, but just wanted to say I think it's a great idea, and am wondering if we should try to integrate it somehow with this earthmover init feature?

Having read through the tutorial I'm not sure what I said actually makes sense. earthmover init generates a fully-working project whereas the tutorial has intentional gaps for the user to fill in. Disregard!

(still think this is great)

tutorial/README.md Outdated Show resolved Hide resolved
tutorial/README.md Outdated Show resolved Hide resolved
Co-authored-by: Ludmila Janda <17114370+ljanda@users.noreply.github.com>
tutorial/README.md Outdated Show resolved Hide resolved

## What is this document?

This document is a step by step tutorial introducing you to Earthmover as a tool - its components and how to run it. The target audience is a data engineer who has never used Earthmover before and who is going to be developing an EM assessment bundle.
Copy link

Choose a reason for hiding this comment

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

Is this just for internal EA DEs or is it also intended for external users?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question. I wrote it with EA DE's in mind, but I suppose since this repo is public, a public audience should be considered.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alternatively, I had originally written this all in slite. If we don't feel ready to have something public, we could move it back to slite (very easy because it's all markdown)

@susanxiong susanxiong requested a review from jalvord1 July 8, 2024 16:35
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