silverstripe / silverstripe/developer-docs
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rules
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
en/02_Developer_Guides/08_Performance/08_Read_only_database_replicas.md (branch 6, line 39) refers to Director.must_use_primary_db_rules.
The framework seems to use a different name: Director::$rule_patterns_must_use_primary_db (framework 6 src/Control/Director.php line 92, read in handleRequest() at line 313), and silverstripe-admin configures the same key in _config/routes.yml (rule_patterns_must_use_primary_db: [admin]).
Someone following the docs would set a key that is never read, with no error. I think the fix is just the name in that sentence and its API link.
Contributor guide
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.
Research direction
Start at en/02_Developer_Guides/08_Performance/08_Read_only_database_replicas.md, branch 6, line 39, and inspect the linked API reference. Verify the configuration name against src/Control/Director.php line 92 and handleRequest() at line 313, plus silverstripe-admin's _config/routes.yml; done means the sentence and API link use the key that the framework reads.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 92/100