Skip to content

docs: sync config.sample.php parameters for 10.16 - #138

Merged
oc-tmueller merged 1 commit into
mainfrom
docs/sync-config-sample-10.16
Sep 18, 2026
Merged

oc-tmueller merged 1 commit into
mainfrom
docs/sync-config-sample-10.16

Conversation

@oc-tmueller

Copy link
Copy Markdown
Contributor

Regenerates the 10.16 config_sample_php_parameters.adoc from core's 10.16 branch. Pure sync — one section was missing.

What was stale

Core added web-updater.enabled to config/config.sample.php in owncloud/core#41385 (commit f1b00f436a, released in v10.16.1) and this page was never regenerated, so the parameter has been undocumented on the 10.16 line ever since.

Why this is a regeneration, not an edit

This page is generated by config-to-docs from core's config sample; the sample is authoritative and says so itself. Produced with ctd.sh against core 10.16, not hand-written.

Checked while doing it — the sync is now complete for this file: core's top-level key set and the page's are identical (no key in core missing from the page, none extra), and every key's heading matches core's first comment line. This one parameter really was the only delta. Everything above the // header end marker is untouched.

Same run confirmed the other three pages need nothing: both config_apps_sample_php_parameters.adoc (11.0 and 10.16) and 11.0's config_sample_php_parameters.adoc regenerate byte-identical to what is committed. web-updater.enabled does not exist in core master, so 11.0 correctly does not get it.

⚠️ This surfaces a contradiction that needs fixing in core

The new section lands four lines below this pre-existing text:

=== Disable the web based updater
The web based updater is enabled by default.

That sentence was invalidated by the very commit that added the parameter — #41385 is titled "web updater is now disabled by default + discourage users to use the web updater". So the published page will state, four lines apart, that the web updater is enabled by default and that it is disabled by default.

I have deliberately not papered over this by editing the generated text, because that would break the property this PR exists to establish. The durable fix is in core:

  • config/config.sample.php — the upgrade.disable-web comment says "enabled by default" on both 10.16 and master, and is wrong on 10.16.1+.
  • The new section is titled "Explicitly enable the web updater" but its sample shows false and never says that true is what enables /updater/, nor carries core's own "not recommended for a long time" guidance from the #41385 changelog.

I did not write that core fix myself because I could not establish the truth per branch without guessing: web-updater.enabled is read nowhere in core's PHP on either branch (it is consumed by the separate updater component), and master's sample does not define the key at all while still carrying the "enabled by default" sentence. That wants someone who knows the updater's intent, not an inference from me.

Merging this is still an improvement — the parameter goes from undocumented to documented, and the stale sentence is already wrong today with or without this PR. But it should not go out unnoted.

Checks

npm ci && npm run antora && npm test pass; the new section renders on the built 10.16 page.

🤖 Generated with Claude Code

The 10.16 page was stale: core added 'web-updater.enabled' to
config/config.sample.php in owncloud/core#41385 and the generated page was
never regenerated, so the parameter has been undocumented for the 10.16 line
ever since.

Regenerated with config-to-docs (`php convert.php config:convert-adoc`) from
core's 10.16 branch, which is the authoritative source for this page. The diff
is purely the one missing section; every other line already matched, and the
hand-written header above the "header end" marker is untouched.

Found while establishing a regeneration baseline for a different change - the
same run confirmed both config_apps_sample_php_parameters.adoc pages and the
11.0 config_sample_php_parameters.adoc are already in sync.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Thomas Müller <323649642+oc-tmueller@users.noreply.github.com>
@oc-tmueller
oc-tmueller requested a review from a team as a code owner September 18, 2026 11:21
@oc-tmueller
oc-tmueller merged commit 718445b into main Sep 18, 2026
4 checks passed
@oc-tmueller
oc-tmueller deleted the docs/sync-config-sample-10.16 branch September 18, 2026 14:00
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