silverstripe / silverstripe/developer-docs
Documentation error for configuration guide
Open
Nobody has claimed this yet.
affects/v4
complexity/low
impact/low
type/docs
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
The configuration documentation for the "Before / After Priorities" guide seems to be incorrect:
It states:
The value section above has two rules:
- It must be merged in before (lower priority than) all other value sections
- It must be merged in after (higher priority than) any value section with a fragment name of "rootroutes"
But the example does not have any "before" rule.
---
Name: adminroutes
# <- No before rule
After:
- '#rootroutes'
- '#coreroutes'
---
SilverStripe\Control\Director:
rules:
'admin': 'SilverStripe\Admin\AdminRootController'
---
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
Open the linked “Before / After Priorities” section in the configuration guide and compare its explanatory bullets with the YAML example. Correct the documentation so the stated priority rules match the example, then review the rendered section for consistency.
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
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100