Integrate missing information about layers and traversing
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Hi,
in https://github.com/plone/bobtemplates.plone/issues/89 there was a discussion if IDefaultBrowerLayer should be a base class for Layers. The answer is yes but the why is nowhere explained.
I wrote a longer explanation about the why together with background info. Since my time is limited and I spent quite a while validating my last reply to the issue with all the background information, I stop here and just file a bug for the docs.
All necessary information is here:
https://github.com/plone/bobtemplates.plone/issues/89#issuecomment-138474557
Backed up by links to real code and tested on demo.plone.org
Since all information is given already, this might be suitable for a beginner.
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 with the background explanation in bobtemplates.plone issue 89 and its linked comment, then locate the documentation section covering layers and traversing. Integrate the explanation of why IDefaultBrowserLayer is a base class for layers, preserving the linked code references; done when the background and rationale are documented clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100