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

Consolidate MySQL connector doc #156

Closed
crandmck opened this issue Nov 11, 2016 · 0 comments
Closed

Consolidate MySQL connector doc #156

crandmck opened this issue Nov 11, 2016 · 0 comments
Assignees
Labels
Milestone

Comments

@crandmck
Copy link
Contributor

crandmck commented Nov 11, 2016

I would like to move the information in https://github.com/strongloop/loopback.io/blob/gh-pages/pages/en/lb2/MySQL-connector.md into https://github.com/strongloop/loopback-connector-mysql/blob/master/README.md so we can have a single source for doc for this connector.

The Basic use section seems questionable because we typically document for use with LoopBack and LB tools, so the juggler dependency is assumed, and the data source is added by using the data source generator (e.g. apic/slc loopback:datasource). I believe this is covered by Creating a MySQL data source.

Once we move the content into the connector README, I will copy the content of https://github.com/strongloop/loopback.io/blob/gh-pages/pages/en/lb2/mysql-README.md into https://github.com/strongloop/loopback.io/blob/gh-pages/pages/en/lb2/MySQL-connector.md, (and delete mysql-README.md from the loopback.io repo.

Then our Jenkins pipeline will ensure that the content from the README is automatically incorporated into the docs.

cc @Amir-61

@crandmck crandmck changed the title Consolidate MySQL doc Consolidate MySQL connector doc Nov 11, 2016
@crandmck crandmck added #plan and removed #tob labels Nov 14, 2016
@crandmck crandmck self-assigned this Nov 23, 2016
@cgole cgole removed the #plan label Jan 7, 2017
@cgole cgole added this to the Sprint 27 milestone Jan 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants