operaton / operaton/documentation
Dependency issues in the quickstart documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 15
- Avg merge
- 7d 18h
- Merged PRs (30d)
- 6
Description
The Quickstart guide for external tasks (https://docs.operaton.org/docs/get-started/quick-start/service-task) contains a JavaScript dependency for operaton-external-task-client-js which is a package that does not currently exist on npm. There is a package called camunda-external-task-client that seems to be the one intended here given that Operaton is a Camunda fork and it provides the same exports.
Either the package needs to be forked to make the install work under the given name or the code needs to be refactored to reference the externally provided package.
I'm not qualified to suggest either as better or may not see all options. In my opinion it sadly makes an avoidable bad first impression if the first real code example already has dependency issues.
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 Quickstart external tasks page at docs/get-started/quick-start/service-task and inspect the referenced JavaScript dependency and example. Verify whether the documented package can be installed and provides the required exports, then make the documentation use a working dependency or clarify the selected alternative.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100