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 163 forks source link

Refactoring docs #71

Closed eddieajau closed 9 years ago

eddieajau commented 9 years ago

This PR executes a major refactoring of the Waterline docs to hopefully improve the way developers can get to the information they want more quickly.

It also adds two new major pieces of content: a simple example walkthrough and a test tutorial.

The completed work might be easier to look at. It can be found here.

dmarcelino commented 9 years ago

I like this! :white_check_mark:

devinivy commented 9 years ago

I made a couple line notes. But this looks fantastic!! Very nice.

I do have one general question/concern for us– I see some terms thrown around, and I'm not sure how consistently they're used in the world of waterline: "collection", "model", "schema", and "ontology".

dmarcelino commented 9 years ago

I'm not sure how consistently they're used in the world of waterline: "collection", "model", "schema", and "ontology".

(Even though I think we can tackle this on another PR) I agree we should converge and use a consistent terminology. I've also came across a discrepancy regarding "one-way" (sails) and "one-to-one" (waterline) associations (https://github.com/balderdashy/waterline-docs/issues/69#issuecomment-101430471).

aars commented 9 years ago

Hi.

Could we have a mention of what validation properties are input validation, db constraints and/or both?

For example required is only used in input validation and does not reflect on the database. notNull on the other hand is used for both input validation and set as a db constraint (where supported).

dmarcelino commented 9 years ago

Regarding the previous comment, check balderdashy/waterline#1012 for more details.

@eddieajau, any updates on this?

eddieajau commented 9 years ago

I've been pulled onto other projects recently. Getting back into the waterline now so hopefully we can wrap this up in the next week.

eddieajau commented 9 years ago

Updates made and branch is mergable again. I recommend we go forward with merging this and then continue with incremental changes. Does that sound fair? Thanks in advance.

dmarcelino commented 9 years ago

I recommend we go forward with merging this and then continue with incremental changes. Does that sound fair?

Agreed. @devinivy, unless you object I say let's pull the big green merge button.

dmarcelino commented 9 years ago

I've raised #83 to continue discussing the concerns raised here.

Great work @eddieajau, thanks!