Skip to content

Commit 9e6f644

Browse files
committed
TASK: update README with upgrade instructions for v2
1 parent ee9eff9 commit 9e6f644

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
@@ -24,6 +24,55 @@ way, based on the learnings of the first iteration. Especially the robustness ha
2424

2525
NOTE: There still exists the pull request https://github.com/Flowpack/Flowpack.DecoupledContentStore/pull/42 containing various improvements, which also should go to 2.x / main branch.
2626

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

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

352+
### Custom Rendering
353+
354+
(NEW with v2)
355+
356+
DecoupledContentStore v1 was specifically tied to Fusion as rendering engine and the Neos Content cache.
357+
This has changed in V2, where **different renderings** of a given document can be instantiated.
358+
359+
(TODO EXPLAIN IN DETAIL)
360+
303361
### Custom Document Metadata, integrated with the Content Cache
304362

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

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

531-
## TODO
532-
533-
- clean up of old content releases
534-
- in Content Store / Redis
535-
- generate the old content format
536-
- (SK) error handling tests
537-
- force-switch possibility
538-
- (AM) UI
539-
- check for TODOs :)
540-
541-
## Missing Features from old
542-
543-
data-url-next-page (or so) not supported
544-
545589
## License
546590

547591
GPL v3

0 commit comments

Comments
 (0)