docs(manuals): extensive rewrite

[papb]

docs(manuals): extensive rewrite

Finally! This is the PR I have been working on for a few months.

I have basically rewritten the whole manuals. This will solve several issues at once.

Summary

• The docs folder was reorganized;

• Almost every manual was rewritten;

• Several new manuals were added;

• A lot more examples were provided;

• And I took care not to break any existing links!

  • Two of the manuals were renamed:

    • manual/dialects.html changed to manual/dialect-specific-things.html;
    • manual/instances.html changed to manual/model-instances.html.

    To make sure the old links for these two still work, I have set up a permanent redirect for the old URLs to the new ones. See docs/redirects and docs/redirects.json.

  • The following five manuals were split into several pages, with a lot more details:

    • associations.md;
    • data-types.md;
    • models-definition.md;
    • models-usage.md;
    • querying.md

  Again, to make sure every link that is around the internet is still valid and useful, each of these pages became a mini-page linking for the new guides. See for example docs/manual/moved/associations.md.

Consequences

This PR will not only make me a lot more comfortable with the Sequelize guides in general, but will also close several issues!

• Closes Why is unique not a validator? #2640
• Closes How do I apply order to includes #4553
• Closes Save/update model with association #5471
• Closes Eager loading retrieves data from "through" table. How to disable? #6541
• Closes Better Documentation With More Examples #8534
• Closes Creating with associations, docs need clarification #9103
• Closes [Docs] Document on the Associations page that you can pass an object to foreignKey #9405
• Closes How to properly use sequelize with transactions #10503
• Closes Include on through association #10828
• Closes Documentation for hasMany and belongsTo is unclear #10860
• Closes sourceKey and targetKey seems to be the same exact thing. #10969
• Closes hasOne 'as' option produces wrong foreign key #10972
• Closes belongTo isn't enough for "include" queries from other table #10974
• Closes Completely confused on how to eager load through table data. #10989
• Closes Sequelize not creating association fields  #11280
• Closes Document the existence of the beforeCount hook #11389
• Closes sequelize instance does not have a Model field (import docs) #11424
• Closes Dead link in docs #11687
• Closes Including related items for a polymorphic relation. #11731
• Closes Can't understand how to add/remove/edit column of an existing model #11745
• Closes migrations (config) #11751
• Closes Docs on "save" do not mention associations #11787
• Closes many-to-many-to-many query #11796

[codecov]

Codecov Report

Merging #11825 into master will decrease coverage by 2.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #11825      +/-   ##
==========================================
- Coverage   96.26%   94.18%   -2.08%     
==========================================
  Files          94       94              
  Lines        9191     9191              
==========================================
- Hits         8848     8657     -191     
- Misses        343      534     +191

Impacted Files	Coverage Δ
lib/model.js	96.54% <ø> (ø)	⬆️
lib/sequelize.js	92.81% <ø> (-3.13%)	⬇️
lib/dialects/mysql/query.js	15.12% <0%> (-83.2%)	⬇️
lib/dialects/mysql/connection-manager.js	29.09% <0%> (-67.28%)	⬇️
lib/dialects/mysql/data-types.js	43.75% <0%> (-54.69%)	⬇️
lib/dialects/mysql/query-generator.js	94.8% <0%> (-3.04%)	⬇️
lib/dialects/abstract/query.js	91.66% <0%> (-0.33%)	⬇️
lib/dialects/abstract/query-generator.js	96.84% <0%> (-0.18%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f3110e3...23d1a42. Read the comment docs.

[sushantdhiman]

Hmm, include support this? Do we have any tests for this case?

[papb]

Good catch. We don't have any tests for this currently. However, it does work!! Should I just add one test for this? Or do you think this shouldn't be officially supported for some reason? I think it's great that it works :)

[sushantdhiman]

Keep it

[sushantdhiman]

Looks really good. Left some comments, I'll run this locally in my evening time for final review.

[jly36963]

I have basically rewritten the whole manuals. This will solve several issues at once.

@papb Thank you for doing this :D

[papb]

For those wondering, the docs website may take at most 48 hours to be updated.

@sushantdhiman Can you manually trigger an update?

[papb]

This also closed #11365, I forgot to put it in the list!