Skip to content

[TASK] Warn that --output is resolved inside the container - #540

Merged
linawolf merged 2 commits into
TYPO3-Documentation:mainfrom
CybotTM:docs/output-container-path
Aug 17, 2026
Merged

[TASK] Warn that --output is resolved inside the container#540
linawolf merged 2 commits into
TYPO3-Documentation:mainfrom
CybotTM:docs/output-container-path

Conversation

@CybotTM

@CybotTM CybotTM commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

The --output option of the render container is resolved inside the container: pointing it at a host path outside the mounted volume writes the files into the container file system, which --rm then discards — while the command still reports success. This adds a note to the shared local-rendering include so every page showing the command carries the warning.

The --output option of the render container is resolved inside the
container: pointing it at a host path outside the mounted volume
writes the files into the container file system, which --rm then
discards - while the command still reports success. Add a note to
the shared local-rendering include so every page showing the
command carries the warning.

Assisted-by: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
@CybotTM
CybotTM force-pushed the docs/output-container-path branch from 493abe7 to aaeced6 Compare August 14, 2026 13:22
@CybotTM CybotTM changed the title [DOCS] Warn that --output is resolved inside the container [TASK] Warn that --output is resolved inside the container Aug 14, 2026
@CybotTM
CybotTM marked this pull request as ready for review August 14, 2026 13:30

@linawolf linawolf left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example command does not show the usage of the output parameter and usually it is not used by ppl just trying out the rendering. So I am wondering if this note block is really needed, expoaccialy since this include is included in so many places throughout the manual

Reviewer feedback: the rendering snippet does not use --output, and
_LocalRendering.rst.txt is included in four places, so a note about it sits
in front of readers who never pass the option.

Move it to the Markdown-to-reST howto, the only page in this manual that
passes --output, and shorten it to the point that matters: the path is
resolved inside the container, so it has to stay below the mounted volume.

Assisted-by: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
@CybotTM

CybotTM commented Aug 15, 2026

Copy link
Copy Markdown
Contributor Author

Moved in f855eb2. You are right that it does not belong there: _LocalRendering.rst.txt is included in four pages and its example never passes --output. The only page in this manual that does is the Markdown-to-reST howto, so the note now sits next to those commands and is down to the point that matters — the path is resolved inside the container and has to stay below the mounted volume, and the relative Documentation-Migrated used there already satisfies that. The shared include is back to what it was. make test-docs renders clean.

@linawolf
linawolf merged commit 18c266b into TYPO3-Documentation:main Aug 17, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants