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

Epic: Better onboarding experience #1920

Open
3 of 4 tasks
raulb opened this issue Oct 16, 2024 · 2 comments
Open
3 of 4 tasks

Epic: Better onboarding experience #1920

raulb opened this issue Oct 16, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation roadmap Planned for a future release
Milestone

Comments

@raulb
Copy link
Member

raulb commented Oct 16, 2024

This issue encompasses:

  • CLI command for conduit init which creates a template pipeline configuration file based on the chosen source and destination (quick and dirty + patch release, to make it available)
  • Write a clear quickstart guide that brings a newcomer to the "aha" moment as fast as possible
  • Video tutorial that follows the quickstart guide for users who want to see Conduit in action without installing it themselves

After this, we should be ready to reach out to users and verify that the onboarding experience makes sense, based on the feedback we can continuously improve it.

Tasks:

@raulb raulb added this to the 0.13.0 milestone Oct 16, 2024
@raulb raulb moved this from Triage to Todo in Conduit Main Oct 16, 2024
@raulb raulb changed the title Conduit: Better onboarding experience Epic: Better onboarding experience Oct 17, 2024
@lovromazgon
Copy link
Member

Draft idea for the quickstart guide:

  1. Install Conduit
  2. Run it
    • Explain that running Conduit now results in an empty instance.
    • Only useful if you want to interact with Conduit via the API.
  3. Build your first pipeline
    • First pipeline should use connectors that don't require external resources.
    • generator -> file is a good candidate.
      • The log destination is another candidate, but file is better, since the records land outside of Conduit and get persisted (as opposed to the log), so it's easier to understand what Conduit is doing.
    • Ideally, we should have a conduit init command in this step.
    • Run Conduit and see data flowing at this stage.
  4. Add your first processor
    • Mask a field or similar. We should identify a simple use case, but one that actually reflects some common processing use case.
    • Restart Conduit and see the updated data flow again.
  5. Refer to next steps
    • Discover connectors
    • Discover advanced features (e.g. DLQ, batching, multiple collections, WASM processors)

@lovromazgon lovromazgon moved this to In Progress in Conduit Roadmap Oct 18, 2024
@raulb raulb moved this from Todo to In Progress in Conduit Main Oct 21, 2024
@raulb raulb added the documentation Improvements or additions to documentation label Oct 23, 2024
@hariso
Copy link
Contributor

hariso commented Nov 8, 2024

FTR, Lovro's suggestion has been split into two pages: one for the getting started guide and one for how to add a processor to a pipeline.

@raulb raulb added the roadmap Planned for a future release label Nov 12, 2024
@simonl2002 simonl2002 moved this from In Progress to Todo in Conduit Main Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation roadmap Planned for a future release
Projects
Status: Todo
Status: In Progress
Development

No branches or pull requests

3 participants