Expand adaptor docs #260
Merged
Expand adaptor docs #260
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
taylordowns2000
requested changes
May 29, 2023
josephjclark
reviewed
Jun 9, 2023
README.md
Outdated
|
|
||
| The configuration schema defines required parameters and their expected values | ||
| - Update the top-level changelog comment `# @openfn/language-template` to your adaptor name and delete the example content. Delete ast.json, then run `pnpm clean` (this will remove the dist, types and docs folders). |
There was a problem hiding this comment.
We probably still want the language- prefix so can we say:
Update the top-level changelog comment `# @openfn/language-template` to `# @openfn/language-youradaptorname`
README.md
Outdated
|
|
||
| #### 2. Create a job with the operation you'd like to add, and run it so it fails | ||
|
|
||
| - Create a _temporary_ folder where you can test your operation manually by running a job: `mkdir tmp` |
There was a problem hiding this comment.
I wouldn't emphasis temporary, it makes it look like you have to do something special. Like, how do I create a temporary folder?
Probably important to note that the contents of tmp don't get checked in to github - so this folder name isn't arbitrary, it's a convention we use.
josephjclark
approved these changes
Jun 21, 2023
amberrignell
commented
Jun 21, 2023
README.md
Outdated
| - The job should fail - we haven't build the adaptor yet! Let's go do that | ||
|
|
||
| #### 3. Create your adaptor function | ||
| - Head to `lib/Adaptor.js`, and define your first function. |
josephjclark
force-pushed
the
contributing
branch
from
d2aae67
to
a4cd838
Compare
|
I am merging this in for today's release. It's an improvement on the current docs and we can raise issues/PRs later if we want to make further changes. Thanks @amberrignell !! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add a high-level, single-sentence summary of what this PR changes.
Details
Add technical details of what you've changed (and why).
Issues
Reference any related issues here.
Review Checklist
Before merging, the reviewer should check the following items:
migration guide followed?
dev only changes don't need a changeset.