databrickslabs / databrickslabs/partner-connect-api
Reference to best practices doc with no link in onboarding doc
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 13
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
In the partner onboarding doc, we mention a best practices doc that we don't provide a link to.
"For more details on product integration, please see "Best practices for building an integration with Databricks" in Resources (below)."
Resources
OpenApi specification
Connectors List
Contributor guide
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
Open OnboardingDoc.md and inspect the product integration paragraph and its Resources section. Add the missing link for “Best practices for building an integration with Databricks,” then verify that the onboarding document clearly points readers to it alongside the existing OpenAPI specification and Connectors List.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100