neos/neos-development-collection

Docs: Fusion mention enableObjectTreeCache in documentation

Open

#2,596 opened on Jul 9, 2019

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)PHP (248 forks)auto 404
Good first issueP: FusionT: Documentation

Repository metrics

Stars
 (267 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, the setting option is neither mentioned on docs.neos.io nor on RTD

https://docs.neos.io/search?search=enableObjectTreeCache https://neos.readthedocs.io/en/stable/search.html?q=enableObjectTreeCache&check_keywords=yes&area=default

but only in the Settings.yaml file itself: https://github.com/neos/neos/blob/master/Configuration/Settings.yaml#L22

This option however can lead to quite confusing behaviour as seen in this slack thread: https://neos-project.slack.com/archives/C050C8FEK/p1562665567171800

Contributor guide

Research direction
Locate the official documentation repository for Neos (e.g., on readthedocs or neos.io) and find the appropriate place to document the enableObjectTreeCache setting from Settings.yaml. Then create a pull request adding the documentation.
Tech stack
php
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90