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

Pull in READMEs for connectors, components #108

Closed
crandmck opened this issue Oct 13, 2016 · 3 comments
Closed

Pull in READMEs for connectors, components #108

crandmck opened this issue Oct 13, 2016 · 3 comments
Assignees
Labels

Comments

@crandmck
Copy link
Contributor

We should use the same technique that we currently use to fetch the example repo READMEs to get the READMEs for all the data source connectors and the components. Also look at any other READMEs we should include into the docs.

This may require some minor modifications to the get-readmes code to allow for a second repos.json file in the _data directory.

@crandmck
Copy link
Contributor Author

I've enhanced get-readmes and we now have all the READMEs in the repo. Unfortunately, there are some wrinkles:

  • Some don't contain the information that they should (I made dev move it to Confluence... doh!)
  • Some have formatting errors.

Work is underway to correct these. See http://loopback.io/doc/en/lb2/tag_readme.html for list of all pages currently transcluding READMEs.

@crandmck
Copy link
Contributor Author

crandmck commented Nov 12, 2016

We need to consolidate the docs and READMEs for several connectors; here are the issues:

@Amir-61 I will do this work, but I'll ask you to review the PRs.

@crandmck
Copy link
Contributor Author

Going to close this since there are issues for the each specific connector/component.

@crandmck crandmck removed the #wip label Dec 14, 2016
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