Documenting the "vendor expose" sorcery
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation
Research direction
Start by locating the existing vendor-expose documentation and implementation references in the SilverStripe project. Map the workflow for project and module resources, template and PHP references, and common debugging cases. Done means a central article covers each acceptance criterion for both developers and module developers.
Written by the indexing model from the issue text.
Description
Affected Version
4 and above
Description
Following some discussion it appears the "vendor expose" process is not super clear for most of the SilverStripe community.
I suggest we fix this by providing a central doc article demystifying the vendor-expose logic.
Acceptance criteria
- As a SilverStripe Developer I can understand:
- The purpose of "vendor-expose",
- How to expose my project resources,
- How to reference project resources and module resources in templates and php files,
- How to debug common issues with vendor expose
- As a SilverStripe Module Developer I can understand:
- How to expose my module's resources and reference them.
- 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
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
alphagov/govuk-frontend-docs#668 ·
Maintainers usually reply within 2 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
bancolombia/scaffold-clean-architecture#1001 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
navikt/esyfo-narmesteleder#615 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 84/100
n8n-io/terraform-aws-n8n#176 ·
Maintainers usually reply within 1 day