Optimistic locking example is missing from the model configuration docs [v6]
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- html
- Domain
- documentation
Research direction
Start with the v6 model configuration documentation and compare it with the linked v5 models-definition configuration section. Check the existing optimistic-locking page for terminology and links, then add the missing version-property configuration example so readers can implement optimistic locking from the model configuration docs.
Written by the indexing model from the issue text.
Description
Issue Description
There is no example of optimistic locking in the documentation.
What was unclear/insufficient/not covered in the documentation
There isn't really any documentation about using the version property to enable optimistic locking. There's a page on optimistic locking that links to the model configuration page. However, the model configuration page doesn't actually contain any details about how to implement optimistic locking in your sequelize schema. This used to be documented in v5 but it seems like after the docs were restructured this was thrown out.
If possible: Provide some suggestion on how we can enhance the docs
Add in the information for configuring optimistic locking back in to the model configuration docs.
Additional context
<-- Add any other context or screenshots about the issue here. -->
- Dominant language
- HTML
- Stars
- 30
- Forks
- 171
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sequelize/website
-
Difficulty 1/5 1-3 hours Newbie friendliness 74/100
-
Update Migration.mdOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Error: Only HasMany associations support include.separateMay be free again @SippieCup claimed this 187 days ago, and no pull request is open. Open
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
All issues in sequelize/website
Similar issues
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
PedestrianDynamics/pyFDS-Evac#475 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ethereum/execution-apis#915 ·
Maintainers usually reply within 1 day
-
area:ansible source:reader type:content-error
Difficulty 1/5 Under an hour Newbie friendliness 86/100
stephrobert/blog-roadmap#42 ·