Documentation for Access Control and Page Security is invalid
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the linked Access Control page, especially the “Permission checking is at class level” section, and review the existing content as a whole. Done means the page has been rewritten into a useful developer guide that properly explains SilverStripe’s Access Control model.
Written by the indexing model from the issue text.
Description
Affected Version
Documentation site
Description
On the documentation site, the Access Control page doesn't contain a lot of useful information, and reads more like a stream of consciousness while someone was reading the code, rather than a useful developer guide. The whole page has this sort of content, but the 'Permission checking is at class level' section is probably the worst offender.
The page should ideally be re-written to properly cover the Access Control model that SilverStripe implements.
I'll try to do this in a PR, but no guarantees - adding this issue in case I don't get a chance to re-write it.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
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.
More from silverstripe/developer-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rules Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
silverstripe/developer-docs#909 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
silverstripe/developer-docs#908 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
silverstripe/developer-docs#907 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
silverstripe/developer-docs#903 ·
All issues in silverstripe/developer-docs
Similar issues
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
githubnext/gh-aw-workshop#3692 ·
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
priority-0
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100