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

Time to update the readme! #899

Open
josephjclark opened this issue Jan 12, 2025 · 0 comments
Open

Time to update the readme! #899

josephjclark opened this issue Jan 12, 2025 · 0 comments

Comments

@josephjclark
Copy link
Collaborator

josephjclark commented Jan 12, 2025 •
edited
Loading

The adaptor readme is not in a good state :(

  • We need simple clear instructions on how to use CLI with adaptors
  • There's something about OPENFN_REPO_DIR which is straight up wrong!
  • Tutorial can be moved out into a) another file or b) the wiki. And then it probably needs an update
  • Link to important articles in the wiki (and point to the wiki generally)
  • This is no longer a "new" home of adaptors
  • Remove the migration guide

I basically want a nice, clean, concise into for devs, with links to more resources elsewhere.

We also need a better onboarding about openfn and adaptors for devs coming in without much context
@github-project-automation github-project-automation bot moved this to New Issues in v2 Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
v2
Status: New Issues
Milestone
No milestone
Development

No branches or pull requests
1 participant
@josephjclark