Skip to content

Commit d92705b

Browse files
skurfuerstPingu501
authored andcommitted
TASK: update README with upgrade instructions for v2
1 parent 7964c77 commit d92705b

1 file changed

Lines changed: 58 additions & 14 deletions

File tree

README.md

Lines changed: 58 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,55 @@ way, based on the learnings of the first iteration. Especially the robustness ha
2222
| 2.x (current `main` branch) | 8.x | ☑️ | current active release | Breaking configuration changes, to support **different renderers** and more flexible rendering overall. Currently used in production in bigger sites. |
2323
| 3.x | 9.x | ⛔️ | ⛔️ | Not yet planned |
2424

25+
### Updating from 1.x to 2.x (not yet released)
26+
27+
You need to adjust the following things when updating from DecoupledContentStore 1.x to 2.x:
28+
29+
NEW FEATURES / IMPROVEMENTS:
30+
31+
32+
33+
UPDATING:
34+
35+
**Settings.yaml - contentReleaseWriters must be configured differently.
36+
37+
OLD:
38+
```yaml
39+
40+
Flowpack:
41+
DecoupledContentStore:
42+
extensions:
43+
contentReleaseWriters:
44+
gzipCompressed:
45+
className: Flowpack\DecoupledContentStore\NodeRendering\Extensibility\ContentReleaseWriters\GzipWriter
46+
legacy:
47+
className: Flowpack\DecoupledContentStore\NodeRendering\Extensibility\ContentReleaseWriters\LegacyWriter
48+
49+
```
50+
51+
NEW:
52+
53+
```yaml
54+
Flowpack:
55+
DecoupledContentStore:
56+
extensions:
57+
# Decide how node rendering should happen.
58+
documentRenderers:
59+
htmlViaFusion:
60+
# ... the other config matches the old behavior ...
61+
62+
# Register additional content release writers, being called for every finished node which should be added
63+
# to the content release.
64+
# (must implement ContentReleaseWriterInterface)
65+
contentReleaseWriters:
66+
gzipCompressed:
67+
className: Flowpack\DecoupledContentStore\NodeRendering\Extensibility\ContentReleaseWriters\GzipWriter
68+
legacy:
69+
className: Flowpack\DecoupledContentStore\NodeRendering\Extensibility\ContentReleaseWriters\LegacyWriter
70+
71+
72+
```
73+
2574
## What does it do?
2675

2776
The Content Store package publishes content from Neos to a Redis database as
@@ -312,6 +361,15 @@ eventually executed, because that's prunner's job.
312361
Crafting a custom `pipelines.yml` is the main extension point for doing additional work (f.e. additional enumeration
313362
or rendering).
314363

364+
### Custom Rendering
365+
366+
(NEW with v2)
367+
368+
DecoupledContentStore v1 was specifically tied to Fusion as rendering engine and the Neos Content cache.
369+
This has changed in V2, where **different renderings** of a given document can be instantiated.
370+
371+
(TODO EXPLAIN IN DETAIL)
372+
315373
### Custom Document Metadata, integrated with the Content Cache
316374

317375
Sometimes, you need to build additional data structures for every individual document. Ideally, you'll want this
@@ -540,20 +598,6 @@ error. Then, you can inspect the testing database and manually reproduce the bug
540598

541599
Additionally, `-vvv` is a helpful CLI flag (extra-verbose) - this displays the full exception stack trace in case of errors.
542600

543-
## TODO
544-
545-
- clean up of old content releases
546-
- in Content Store / Redis
547-
- generate the old content format
548-
- (SK) error handling tests
549-
- force-switch possibility
550-
- (AM) UI
551-
- check for TODOs :)
552-
553-
## Missing Features from old
554-
555-
data-url-next-page (or so) not supported
556-
557601
## License
558602

559603
GPL v3

0 commit comments

Comments
 (0)