Provided better non-technical errors for CLI/Sync (also github)
Open
Nobody has claimed this yet.
bug
- Dominant language
- Elixir
- Stars
- 296
- Forks
- 86
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 50
Description
This may be fixed when a bug related to indentation (#2966) is sorted out. Let's track and check back later.
We have made significant progress with error messages returned during syncs or when using the provisioner (openfn pull/deploy).
Below are two new errors we have seen recently and it would be great to:
- Know what they mean, so we can improve documentation to avoid/manage this
- Catch and make the message more understandable for the users
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the two error examples in the issue and the linked indentation issue #2966, then trace the CLI/Sync and provisioner flows for openfn pull/deploy. Done means the errors are understood, documented to help users avoid or manage them, and returned with clearer messages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100