Skip to content

fix: more work on OC11 docs#1557

Merged
DeepDiver1975 merged 33 commits into
masterfrom
more_work_on_oc11
Jul 8, 2026
Merged

fix: more work on OC11 docs#1557
DeepDiver1975 merged 33 commits into
masterfrom
more_work_on_oc11

Conversation

@mmattel

@mmattel mmattel commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

This PR adds more required changes for the OC11 docs

@mmattel mmattel force-pushed the more_work_on_oc11 branch from c747123 to 839fc20 Compare July 7, 2026 06:50
@mmattel mmattel marked this pull request as ready for review July 7, 2026 11:11
@mmattel mmattel requested a review from a team as a code owner July 7, 2026 11:11

@DeepDiver1975 DeepDiver1975 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.

Reviewed the OC11 doc restructuring. Build + lint green, and Antora resolved every page-level xref: — the four deleted pages (configuration_notes, manually-moving-data-folders, maintenance/migrating, and the moved deployment/apps pages) all have matching :page-aliases:, so page links keep working. Image cleanup is clean too: no page still references a deleted impersonate/sharepoint image, no impersonate/sharepoint pages remain, and index.adoc correctly states Sharepoint is retired — consistent with the #1555 archived-app removal (no conflict, not re-adding them).

One real issue: broken fragment anchors. Antora validates page targets but not #fragments, so the build stays green while these deep-links land at the top of the target page instead of the intended section.

  1. envvars.adoc:140,142,166xref:enterprise/installation/install.adoc#license-keys[...]. The alias resolves to installing_with_docker.adoc, but its section is == Enterprise License Keys → anchor #enterprise-license-keys. #license-keys does not exist. Fix: use #enterprise-license-keys, or add an explicit [#license-keys] anchor on that heading.
  2. troubleshooting/general_troubleshooting.adoc:131xref:installation/configuration_notes.adoc#using-a-configuration-file[...]. Aliased to the new important_notes.adoc, where the old == Using a Configuration File section is now == Using Configuration Keys → anchor #using-configuration-keys. Fix the fragment (this page isn't in the PR, but the rename broke the link).

Minor nit:

  • nav.adoc:20 — double slash installation//apps/apps_supported.adoc. Harmless (Antora normalizes it) but worth tidying.

Coverage note: I verified build integrity, all page-level xref/alias resolution, image orphans, and the #1555 archived-app coherence exhaustively, and spot-checked envvars/apps_supported/important_notes/config_sample content — I did not line-read every prose edit across the 51 files. Nothing out of scope surfaced; changes are coherent OC11 Docker-only doc updates.

Fix the fragment anchors (esp. the 3 in the new envvars.adoc) and this is good to go.

🤖 Generated with Claude Code

@dj4oC dj4oC left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Continues the OC11 Docker-only docs rework: adds a new envvars.adoc reference and important_notes.adoc, rewrites admin_audit.adoc and the data-directory/instance migration pages, and updates numerous enterprise pages plus nav; removes retired impersonate/sharepoint screenshots (no dangling image references found).

Findings

Accuracy

  • modules/admin_manual/pages/maintenance/migrate_owncloud/migrate-datadirectory.adoc: both UPDATE oc_storages and UPDATE oc_accounts SQL examples end their WHERE clause with a stray backtick before the semicolon (WHERE id LIKE 'local::%'\;andWHERE home LIKE '/var/www/owncloud/data%'`;`). If an admin copies these verbatim they will hit a SQL syntax error. The backtick should be removed.

Broken links/references

  • New envvars.adoc has 3 occurrences of xref:enterprise/installation/install.adoc#license-keys[documentation] (for the license-key related env vars). The page-level target resolves via :page-aliases: to installing_with_docker.adoc, but that page's heading is == Enterprise License Keys. With this site's idprefix: '' / idseparator: '-' attributes (from owncloud/docs global-attributes.yml), the actual anchor is #enterprise-license-keys, not #license-keys. Antora doesn't validate fragments, so the build stays green but these links will land at the top of the page instead of the section. Should be #enterprise-license-keys.
  • partials/nav.adoc: doubled slash in installation//apps/apps_supported.adoc — Antora normalizes it, so harmless, but worth tidying.

Formatting

  • enterprise/logging/admin_audit.adoc, second after_set_acl`descriptor[] keys` table: a table cell reads | `owner (missing closing backtick), unlike the matching cell in the first occurrence of the same table which correctly has `owner`. Won't break the build, but renders incorrectly.
  • New attribute :mysql-string-replace-function-url: http://www.mysqltutorial.org/... uses http://; consider https:// if the target supports it.
  • configuration/user/login_policies.adoc adds an author TODO comment (// if there will be no one envvar for loginPolicy.groupLoginPolicy.forbidMap...) — an AsciiDoc comment so it won't render, but looks like it wasn't meant to be left in for merge.

Nothing here breaks the Antora build (verified xref page-targets resolve via existing aliases, no orphaned image references from the removed impersonate/sharepoint screenshots, no credentials/internal hosts introduced).

Verdict

Commenting — non-blocking issues worth fixing before merge (stray backticks in copy-paste SQL examples, broken #license-keys fragment anchors).

🤖 Automated review by Claude Code


Generated by Claude Code

@mmattel

mmattel commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

I addressed and fixed the issues found via individual commits to track the changes made

@DeepDiver1975 DeepDiver1975 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.

Re-review of 3f429da. The 3 prior findings are fixed:

  • envvars.adoc:140/142/166 now target installing_with_docker.adoc#enterprise-license-keys — anchor is real (== Enterprise License Keys).
  • general_troubleshooting.adoc — the #using-a-configuration-file deep-link is gone.
  • nav.adoc:20 double-slash gone.

One new broken in-page fragment slipped in with this push (same class Antora's build doesn't validate):

  • envvars.adoc:235,239,241,243 — all four link xref:configuration/files/big_file_upload_configuration.adoc#configuring-via-php-global-settings[documentation], but that anchor does not exist. big_file_upload_configuration.adoc has no #configuring-via-php-global-settings (its sections are Introduction / General Considerations / Configuration / Apache Config LimitRequestBody / General Upload Issues / Long-Running Uploads), and the string exists nowhere else in the repo. Likely intended: #configuration.

Fix that and it's good to go. Build + lint are green.

🤖 Generated with Claude Code

@DeepDiver1975 DeepDiver1975 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.

Thanks for the OC11 docs migration work — the prose reads well overall. I've left inline comments on a set of concrete defects, mostly in copyable config values and AsciiDoc markup that will render broken.

Blocking (broken render or wrong value a user would copy):

  • admin_audit.adocOWNCLOUD_LOG_CONDITIONS example filters files_external instead of admin_audit, and mixes single quotes into JSON so it won't parse.
  • metrics.adoc — table header missing a closing quote breaks the new two-column table.
  • envvars.adoc — garbled OWNCLOUD_PROTOCOL variable name; doubled brace in the OWNCLOUD_OVERWRITE_CLI_URL default; Markdown link syntax across the 10 OWNCLOUD_REDIS_TLS_* entries and OWNCLOUD_SAVE_VERSION_METADATA; label-less xref: + doubled paren in OWNCLOUD_CRON_LOG.
  • clustered_shared_storage.adoc:page-aliases: typo (clsutered) leaves the pre-move URL without a redirect.
  • windows-network-drive_configuration.adocnt authority\system was changed to the invalid authority\system.

Minor (worth fixing while in these files):

  • "teh" typo in enterprise_only_auth.adoc; `tue``true` in the admin_audit.adoc table; [source,.env] / stale [source,php] language tags on converted env-var blocks.

Details and suggested fixes are in the line comments.

Comment thread modules/admin_manual/pages/enterprise/logging/admin_audit.adoc Outdated
Comment thread modules/admin_manual/pages/enterprise/reporting/metrics.adoc Outdated
Comment thread modules/admin_manual/pages/configuration/envvars/envvars.adoc Outdated
Comment thread modules/admin_manual/pages/configuration/envvars/envvars.adoc Outdated
Comment thread modules/admin_manual/pages/configuration/envvars/envvars.adoc
Comment thread modules/admin_manual/pages/enterprise/authentication/enterprise_only_auth.adoc Outdated
Comment thread modules/admin_manual/pages/enterprise/logging/admin_audit.adoc Outdated
DeepDiver1975 and others added 4 commits July 8, 2026 00:07
- OWNCLOUD_PROTOCOL: restore the variable name (was replaced by escape junk)
- OWNCLOUD_OVERWRITE_CLI_URL: remove the doubled brace in the default value and use consistent escaping
- OWNCLOUD_CRON_LOG: add the missing xref link label and fix the doubled paren
- OWNCLOUD_SAVE_VERSION_METADATA and OWNCLOUD_REDIS_TLS_*: replace Markdown link syntax with AsciiDoc link macros

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
- OWNCLOUD_LOG_CONDITIONS: target the admin_audit app instead of files_external, and use valid JSON (double-quoted logfile value)
- fix `tue` -> `true` typo in the public_link_accessed table

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
- metrics.adoc: close the cols quote so the two-column table renders
- clustered_shared_storage.adoc: fix "clsutered" page-alias typo so the pre-move URL redirects
- windows-network-drive_configuration.adoc: restore the valid "nt authority\system" account name

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
- msoffice-wopi-integration.adoc: the env-var block was still tagged as php; switch to .env (keeping subs for the {oc-support-url} attribute)
- enterprise_only_auth.adoc: fix "teh" -> "the" typo

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
Comment thread modules/admin_manual/pages/enterprise/security/ransomware-protection.adoc Outdated
Comment thread modules/admin_manual/pages/enterprise/security/ransomware-protection.adoc Outdated
Doing so allows all user data that is synchronized with the server to be
rolled back to its state before the attack occurred. A combination of
Ransomware prevention and protection reduces risks to a minimum acceptable level.
Doing so allows all user data that is synchronized with the server to be rolled back to its state before the attack occurred. A combination of Ransomware prevention and protection reduces risks to a minimum acceptable level.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For example, this sentence just mentions "the server", which reads fine to me, as long as we have previously written "the ownCloud Classic server".


* Ransomware Protection works with master-key based storage encryption.
With credential-based storage encryption, only Ransomware Prevention
* Ransomware Protection works with master-key based storage encryption. With credential-based storage encryption, only Ransomware Prevention

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not directly related, but I thought that master-key encryption was going to be the only encryption system, and that the old user-key encryption was being removed?

Comment thread modules/admin_manual/pages/enterprise/logging/admin_audit.adoc Outdated
Comment thread modules/admin_manual/pages/installation/installing_with_docker.adoc Outdated
Comment thread modules/admin_manual/pages/installation/installing_with_docker.adoc Outdated
Comment thread modules/admin_manual/pages/maintenance/migrate_owncloud/migrating.adoc Outdated
@DeepDiver1975

Copy link
Copy Markdown
Member

Re-review @ 5e088fb — all 7 findings still open

I re-reviewed after the latest commits (28b33b5 remove firewall.branded_clients docs, d60a7c0 remove unused envvars). Those two changes are clean — the firewall section was removed whole (no dangling anchor) and the removed envvars are unrelated. But none of the 7 findings from my previous review have been addressed yet; they all still reproduce on the current head. Refreshed locations, most severe first:

  1. maintenance/migrate_owncloud/migrate-datadirectory.adoc:147,180,211BEGIN TRANSACTION; is invalid MySQL/MariaDB syntax. Use START TRANSACTION; (or BEGIN;). As-is, all three table migrations error out at the first statement.

  2. enterprise/logging/admin_audit.adoc:88 — Splunk monitor stanza is malformed: [monitor:/<mount_point>/files/admin_audit.log] needs the [monitor://<path>] scheme (two slashes). As written the input silently does nothing.

  3. configuration/envvars/envvars.adoc — wrong config_sample_php_parameters.adoc anchors (valid targets, so yarn validate passes, but wrong section):

    • :167 OWNCLOUD_LOGIN_POLICY_ORDER#define-additional-login-buttons-on-the-logon-screen (should be #order-of-login-policies)
    • :288 OWNCLOUD_POLLINTERVAL#define-the-ttl-for-garbage-collection (should be #define-the-suggested-poll-interval-for-clients)
    • :398 OWNCLOUD_SHARING_SHOW_PUBLIC_LINK_QUICK_ACTION#define-an-alternative-share-provider (should be #show-a-quick-action-for-the-public-link-creation)
    • :414 OWNCLOUD_STRICT_LOGIN_ENFORCED#enforce-token-only-authentication-… (should be #enforce-a-strict-login-check-with-the-user-backend)
    • :420 OWNCLOUD_TELEMETRY_ENABLED#define-owncloud-operation-modes (should be #enable-sending-telemetry-reports-for-enterprise-customers)
    • :450/:452 OWNCLOUD_WEB_BASEURL / OWNCLOUD_WEB_REWRITE_LINKS#override-cli-url (should be #define-the-web-base-url / #define-rewrite-private-and-public-links)
  4. configuration/envvars/envvars.adoc:376OWNCLOUD_SAVE_VERSION_METADATA hardcoded https://doc.owncloud.com/... links use .adoc — the published site serves .html, so both absolute links 404.

  5. configuration/user/login_policies.adoc:12 — leftover internal TODO comment (// if there will be no one envvar for loginPolicy.groupLoginPolicy.forbidMap …) shouldn't ship.

  6. enterprise/user_management/user_auth_shibboleth.adoc:103 — missing space: …to authenticate.The ownCloud Android….

  7. installation/installing_with_docker.adoc:160 — garbled sentence: The same rules trusted domains apply to everything else. (word order scrambled).

#1, #2, and #3 are the ones that will actually mislead/break for a reader following the docs.

🤖 Generated with Claude Code

@DeepDiver1975

Copy link
Copy Markdown
Member

Re-review @ 1986ee7 — 3 fixed ✅, 4 still open

Verified against the latest commits. Fixed:

  • F1 migrate-datadirectory.adoc — now START TRANSACTION; (×3).
  • F2 admin_audit.adoc:88[monitor://<mount_point>/…] slash restored.
  • F7 installing_with_docker.adoc:160 — now reads "The same rules for trusted domains apply to everything else."

Still open:

F3 — configuration/envvars/envvars.adoc: wrong config_sample_php_parameters.adoc anchors (targets exist so yarn validate passes, but point to the wrong section):

  • :168 OWNCLOUD_LOGIN_POLICY_ORDER#define-additional-login-buttons-on-the-logon-screen → should be #order-of-login-policies
  • :288 OWNCLOUD_POLLINTERVAL#define-the-ttl-for-garbage-collection → should be #define-the-suggested-poll-interval-for-clients
  • :398 OWNCLOUD_SHARING_SHOW_PUBLIC_LINK_QUICK_ACTION#define-an-alternative-share-provider → should be #show-a-quick-action-for-the-public-link-creation
  • :414 OWNCLOUD_STRICT_LOGIN_ENFORCED#enforce-token-only-authentication-… → should be #enforce-a-strict-login-check-with-the-user-backend
  • :420 OWNCLOUD_TELEMETRY_ENABLED#define-owncloud-operation-modes → should be #enable-sending-telemetry-reports-for-enterprise-customers
  • :450/:452 OWNCLOUD_WEB_BASEURL / OWNCLOUD_WEB_REWRITE_LINKS#override-cli-url → should be #define-the-web-base-url / #define-rewrite-private-and-public-links

F4 — configuration/envvars/envvars.adoc:376 OWNCLOUD_SAVE_VERSION_METADATA hardcoded https://doc.owncloud.com/... links use .adoc; the published site serves .html, so both 404.

F5 — configuration/user/login_policies.adoc:12 leftover internal TODO comment (// if there will be no one envvar for loginPolicy.groupLoginPolicy.forbidMap …).

F6 — enterprise/user_management/user_auth_shibboleth.adoc:103 missing space: …to authenticate.The ownCloud Android….

🤖 Generated with Claude Code

@mmattel

mmattel commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

The comment in configuration/user/login_policies.adoc is intentional and will be kept until the case is resolved

@DeepDiver1975

Copy link
Copy Markdown
Member

Re-review @ 1db2adc — 6 of 7 fixed ✅, 1 left

Verified the latest commits:

  • F3 — all 7 envvar anchors now point to the correct sections (confirmed each target exists in config_sample_php_parameters.adoc).
  • F4OWNCLOUD_SAVE_VERSION_METADATA links converted to internal xref: (no more .adoc in an external URL — cleaner than a plain .html swap 👍).
  • F6 — space restored: …to authenticate. The ownCloud Android….

One remaining:

F5 — configuration/user/login_policies.adoc:12 — the internal TODO comment is still there:

// if there will be no one envvar for loginPolicy.groupLoginPolicy.forbidMap , we need to add: include::partial$manual_config_file.adoc[]

It's a line comment so it won't render, but it's leftover dev scaffolding — either delete it or resolve the include it references. Once that's gone the review is clean.

🤖 Generated with Claude Code

@phil-davis phil-davis self-requested a review July 8, 2026 09:51
phil-davis
phil-davis previously approved these changes Jul 8, 2026

@phil-davis phil-davis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Text is looking clean from my point-of-view.
I will let Claude look after the analysis of dangling links etc.

@DeepDiver1975

Copy link
Copy Markdown
Member

Re-review @ 1db2adc — ✅ clean, no open findings

All actionable findings from the earlier reviews are resolved:

  • F1 migrate-datadirectory.adocSTART TRANSACTION;
  • F2 admin_audit.adoc[monitor://…] slash restored
  • F3 envvars.adoc — all 7 env-var anchors point to the correct sections
  • F4 envvars.adocOWNCLOUD_SAVE_VERSION_METADATA uses internal xref: links
  • F6 user_auth_shibboleth.adoc — sentence spacing fixed
  • F7 installing_with_docker.adoc — sentence corrected

The remaining item (the login_policies.adoc // …forbidMap comment) is intentional per the maintainers, so it's not a finding.

No further issues from my side. 👍

🤖 Generated with Claude Code

@DeepDiver1975

Copy link
Copy Markdown
Member

Grammar & typo pass @ 1db2adc

I scanned every line this PR adds (verifying each hit against the diff so I don't flag pre-existing text that was only reformatted). Genuine, PR-introduced issues below, grouped by confidence.

Clear typos / misspellings

File:line Issue Fix
configuration/envvars/envvars.adoc:292 and :314 an ownCoud installation command ownCloud
configuration/envvars/envvars.adoc:234 animated GIF´s (plural apostrophe + stray acute accent ´) GIFs
configuration/envvars/envvars.adoc:282 Override ownClouds webroot ownCloud's
configuration/envvars/envvars.adoc:378 Define ownClouds internal secret ownCloud's
enterprise/logging/admin_audit.adoc:66 via your browsers admin page browser's
maintenance/migrate_owncloud/migrating.adoc:48 white-listed using a environment variable an environment variable
maintenance/migrate_owncloud/migrate-datadirectory.adoc:117 part of a NFS mount point an NFS
maintenance/migrate_owncloud/migrating.adoc:65 …needs to be customised . (stray space before period) customised.

Awkward phrasing (worth a maintainer's eye)

  • enterprise/authentication/kerberos.adoc:12 — "the app will not enable unless the kvno tool exists" reads oddly; suggest "the app will not be enabled unless…". Also a trailing space at line end.

Out of scope (verified pre-existing, only reformatted by the PR — flag only if you want to clean them while touching the lines)

These appear on both the removed and added sides of the diff (audit-log tables reflowed from one-line to multi-line rows), so they are not introduced here:

  • admin_audit.adoc — recurring the … files identifier (should be file's), The path of shared item (missing the), contains to following keys (→ the following), contains following keys (missing the), The full path to the create file (→ created).
  • ldap_home_connector_configuration.adocaccording your setup (missing to).
  • windows-network-drive_configuration.adocif you setup WND (verb → set up), the lock will timeout (verb → time out).
  • ransomware-protection.adocrollback user data used as a verb (→ roll back).

British spellings (customised, optimised, behaviour, analyse, licence-as-noun) are house style and were not flagged.

🤖 Generated with Claude Code

@phil-davis

Copy link
Copy Markdown
Contributor

Claude, I have reviewed your comment #1557 (comment)
Those suggested corrections all look good to me. Thanks for the review. Can we get you to make the edits?

Apply proofreading findings from PR review:

- envvars.adoc: "GIF´s" -> "GIFs", "ownClouds" -> "ownCloud's" (x2),
  "ownCoud" -> "ownCloud" (x2)
- admin_audit.adoc: "browsers admin page" -> "browser's admin page"
- migrating.adoc: "a environment variable" -> "an environment variable";
  remove stray space before period
- migrate-datadirectory.adoc: "a NFS" -> "an NFS"
- kerberos.adoc: "app will not enable unless" -> "app will not be enabled
  unless"; drop trailing whitespace

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
@DeepDiver1975 DeepDiver1975 merged commit 5c56eb2 into master Jul 8, 2026
2 checks passed
@DeepDiver1975 DeepDiver1975 deleted the more_work_on_oc11 branch July 8, 2026 10:43
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.

4 participants