Add namespaces to code examples in docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- graphql, yaml
- Domain
- documentation
Research direction
The issue does not name specific files or tests. Start by inventorying code examples throughout the documentation, then identify which examples use Silverstripe namespaces and which formats, such as YAML or GraphQL, have different namespace requirements. Done means every applicable example clearly shows namespaces without adding them where the format does not require them.
Written by the indexing model from the issue text.
Description
Currently most of the code examples in the docs do not include namespaces. This is a holdover from the SS3 days, and can in some cases result in a lack of clarity over whether namespaces should be included (e.g. most yaml config needs it but graphql for example doesn't always need namespaces).
We should add namespaces to all of the code examples so that it's clear how namespaces fit in with Silverstripe code.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 75
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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
-
6.0.0 changelog: DBField formatters on array getters now render emptyPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
silverstripe/developer-docs#912 · 1 comment ·
-
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_rulesOpenaffects/v6 complexity/low impact/low type/docs
Difficulty 1/5 Under an hour Newbie friendliness 92/100
silverstripe/developer-docs#909 · 1 comment ·
-
affects/v6 complexity/low impact/low type/docs
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
silverstripe/developer-docs#908 · 1 comment ·
-
affects/v5 affects/v6 complexity/low impact/low type/docs
Difficulty 1/5 Under an hour Newbie friendliness 90/100
silverstripe/developer-docs#907 · 1 comment ·
All issues in silverstripe/developer-docs
Similar issues
-
accepting PR Content:HTML
Difficulty 1/5 Under an hour Newbie friendliness 88/100
mdn/content#45988 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
pyca/verified-garbage#1023 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
quickemu-project/quickemu#1960 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100