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.

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

[Spike] docs: untangle connector reference into reference, how-to guides and tutorials #5961

Closed
1 task
dhmlau opened this issue Jul 17, 2020 · 1 comment · Fixed by #6061
Closed
1 task
Assignees
Milestone

Comments

@dhmlau
Copy link
Member

dhmlau commented Jul 17, 2020

Originated from: #5786

Part of #5960

Acceptance Criteria

  • Review the existing connector reference contents and create a plan on how to extract out content into reference, how-to guides and tutorials.
@agnes512
Copy link
Contributor

Discussion from the estimation meeting:

Can follow the process or have a high-level docs to talk about the commonalities of connectors (learning tree of connectors:

  • what is connectors
  • what role it plays in req/res cycle, and what relation it has between model and other artifacts
  • connector types:
    • SQL (transaction), NoSQL (freeform properties)
    • Services connectors (service proxy) and others
  • How-to (in common)
    • how type maps
    • how to customize table/column names
    • how to discover/migration tables/models
  • Explain challenges

Candidates for references should be specific contents, e.g handling objectId (MongoDB)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants