silverstripe / silverstripe/developer-docs
Documenting the "vendor expose" sorcery
Open
Nobody has claimed this yet.
affects/v4
complexity/low
type/docs
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
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.
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 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.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100