search

balderdashy / waterline-docs

WARNING: The content in this repo is out of date! See https://github.com/balderdashy/sails-docs for the most up-to-date documentation
452 stars 161 forks source link

Refactor associations #69

Open eddieajau opened 9 years ago

eddieajau commented 9 years ago

I'd like to refactor the "association" doc page into separate pages for each type of association, and make sure the information is in line with the Sails docs at the same time. Does that sound reasonable?

dmarcelino commented 9 years ago

Sounds reasonable to me.

devinivy commented 9 years ago

:+1: Yup!

eddieajau commented 9 years ago

Ok thanks. What I might do is end up refactoring the whole TOC if that's ok.

eddieajau commented 9 years ago

Ended up refactoring the whole repo.

https://github.com/eddieajau/waterline-docs/tree/refactor

Comments welcome.

dmarcelino commented 9 years ago

Oh wow, awesome work @eddieajau! My comments below, all minor things:

1.In installation.md I don't think we need the stuff in New to Node.js? and further below since someone interested in waterline is very likely already using node.

  1. The Getting Started looks awesome!
  2. Associations: on the TOC I would move dominance to the end (after Many-to-many through) since it's a slightly advanced use case and not always needed;
  3. Regarding Testing, Integration and Sails, is there any work in progress regarding them? As a general principle I don't like empty pages as it's quite frustrating for a reader to click on one and finding out it's empty.

This is a very significant improvement to the docs, now just from glancing at the README.md one can immediately grasp waterline's features. Great stuff, thanks for this!

eddieajau commented 9 years ago

Thanks.

I've moved the new-to-node to it's own page and made the link less conspicuous. I think the page is worthwhile, if only to be a search engine magnet once in a while.

I've made dominance less dominant.

I've written the page on testing. It's one of many possible solutions but it works (suggestions welcome).

Integration and sails - yeah I know. Basically I wanted a page to explain water Sails automatically wires up for you. At the moment it's in the round-to-it bucket.

dmarcelino commented 9 years ago

@eddieajau you are on :fire: ! I like the new changes :+1:

dmarcelino commented 9 years ago

Regarding this topic, we should address the issue raised in https://github.com/balderdashy/waterline/issues/992#issuecomment-100938444, namely what sails calls One Way Association, waterline calls it One-to-one. We really should be clear and consistent as this confuses people...