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

Sequelize 7 Documentation #330

Merged
merged 59 commits into from
Jun 21, 2023
Merged

Sequelize 7 Documentation #330

merged 59 commits into from
Jun 21, 2023

Conversation

ephys
Copy link
Member

@ephys ephys commented Nov 6, 2022

This PR is the start of a pretty thorough documentation rewrite. I'm planning on rewriting in this PR:

  • the intro (minimal changes)
  • getting started (minimal changes)
  • how to define models (massive changes)
  • how to sync (sequelize.sync, not migrations) tables
  • querying (massive changes)
    • raw SQL chapter
    • JSON querying chapter
    • Operators
    • JOINS
  • Associations
    • polymorphic associations

Follow-up PRs:

  • Model Inheritance
  • timestamp & Version decorators

Not planned in this PR:

  • anything left in "other topics"
  • the cli

This PR is a complete re-organization of our structure. I'm attempting to write it in the order a new user would normally follow:

  1. install
  2. create models
  3. sync them to your DB (sync & migrations)
  4. insert data & query tables
  5. advanced topic: associations
  6. other advanced topics

Each one is a chapter that can contain both basic and advanced topics. They're easier to find when they're grouped by a theme (e.g. defining models) rather than "basic topics and advanced topics" (like we currently have where defining models is in one place but the data types are in a completely different place)

I'm also going for TypeScript-first as much as possible

@WikiRik
Copy link
Member

WikiRik commented Nov 6, 2022

With this PR we should look into mapping old URLs to new ones (#284 (comment))


And this might be a good PR to fix the highlighted line in light mode;
image image

@ephys
Copy link
Member Author

ephys commented Nov 6, 2022

The highlight is fixed in the hooks pr :)

@WikiRik
Copy link
Member

WikiRik commented Nov 6, 2022

The highlight is fixed in the hooks pr :)

Ah yes, I thought that I've seen it work properly before. There it was. Thanks!

@ephys
Copy link
Member Author

ephys commented Dec 6, 2022

Algolia provides a list of searches that had no results:

image

I'll try to tackle at least some of them in this PR

@ephys
Copy link
Member Author

ephys commented Jan 20, 2023

I think the following pages are ready for a first review (which would need to be done locally):

  • intro
  • getting started
  • the models & tables chapter

The rough reading order is also set:

  • first the "getting started" (I don't expect that many people will read the intro)
  • then "Defining a Model" & other misc pages in "Models & Table" based on the user's need
  • followed by the querying chapter
  • And finally, associations

Associations & Querying are still in progress. I don't think I'll work on the following pages in this PR:

  • Sequelize CLI
  • Other topics

@ephys
Copy link
Member Author

ephys commented Jan 25, 2023

Note to myself: we should document "logQueryParameters" in the section about logging

@ephys ephys requested a review from WikiRik June 1, 2023 13:01
Copy link
Member

@WikiRik WikiRik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still need to go through the associations folder and then do a quick look through the deleted files, but this is part 2 of my review

docs/models/defining-models.mdx Outdated Show resolved Hide resolved
docs/models/validations-and-constraints.md Outdated Show resolved Hide resolved
docs/models/indexes.md Outdated Show resolved Hide resolved
docs/models/model-typing.mdx Outdated Show resolved Hide resolved
docs/querying/select-in-depth.md Outdated Show resolved Hide resolved
docs/querying/select-in-depth.md Outdated Show resolved Hide resolved
docs/querying/select-in-depth.md Outdated Show resolved Hide resolved
docs/querying/select-in-depth.md Outdated Show resolved Hide resolved
docs/querying/select-in-depth.md Outdated Show resolved Hide resolved
@ephys
Copy link
Member Author

ephys commented Jun 17, 2023

@WikiRik I believe I've implemented all requested changes

@ephys ephys requested a review from WikiRik June 17, 2023 15:30
Copy link
Member

@WikiRik WikiRik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not gone through the deleted files in detail yet, but that should not block the merging of this PR. These are my last few comments and then we should be good to merge

docs/associations/has-one.md Outdated Show resolved Hide resolved
docs/associations/faq.md Show resolved Hide resolved
docs/associations/has-many.md Outdated Show resolved Hide resolved
docs/associations/belongs-to-many.md Outdated Show resolved Hide resolved
@ephys ephys requested a review from WikiRik June 21, 2023 14:26
Copy link
Member

@WikiRik WikiRik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One big step closer to the first v7 beta!

@ephys ephys merged commit ab84fd4 into main Jun 21, 2023
1 check passed
@ephys ephys deleted the ephys/docs-rewrite branch June 21, 2023 14:47
@ephys
Copy link
Member Author

ephys commented Jun 21, 2023

We still have a bunch of things to document, but I'm glad this one is behind us 😮‍💨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants