fix: more work on OC11 docs#1557
Conversation
c747123 to
839fc20
Compare
DeepDiver1975
left a comment
There was a problem hiding this comment.
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.
envvars.adoc:140,142,166—xref:enterprise/installation/install.adoc#license-keys[...]. The alias resolves toinstalling_with_docker.adoc, but its section is== Enterprise License Keys→ anchor#enterprise-license-keys.#license-keysdoes not exist. Fix: use#enterprise-license-keys, or add an explicit[#license-keys]anchor on that heading.troubleshooting/general_troubleshooting.adoc:131—xref:installation/configuration_notes.adoc#using-a-configuration-file[...]. Aliased to the newimportant_notes.adoc, where the old== Using a Configuration Filesection 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 slashinstallation//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
left a comment
There was a problem hiding this comment.
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: bothUPDATE oc_storagesandUPDATE oc_accountsSQL examples end theirWHEREclause 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.adochas 3 occurrences ofxref:enterprise/installation/install.adoc#license-keys[documentation](for the license-key related env vars). The page-level target resolves via:page-aliases:toinstalling_with_docker.adoc, but that page's heading is== Enterprise License Keys. With this site'sidprefix: ''/idseparator: '-'attributes (fromowncloud/docsglobal-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 ininstallation//apps/apps_supported.adoc— Antora normalizes it, so harmless, but worth tidying.
Formatting
enterprise/logging/admin_audit.adoc, secondafter_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/...useshttp://; considerhttps://if the target supports it. configuration/user/login_policies.adocadds 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
|
I addressed and fixed the issues found via individual commits to track the changes made |
DeepDiver1975
left a comment
There was a problem hiding this comment.
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-filedeep-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.adochas 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
left a comment
There was a problem hiding this comment.
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.adoc—OWNCLOUD_LOG_CONDITIONSexample filtersfiles_externalinstead ofadmin_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— garbledOWNCLOUD_PROTOCOLvariable name; doubled brace in theOWNCLOUD_OVERWRITE_CLI_URLdefault; Markdown link syntax across the 10OWNCLOUD_REDIS_TLS_*entries andOWNCLOUD_SAVE_VERSION_METADATA; label-lessxref:+ doubled paren inOWNCLOUD_CRON_LOG.clustered_shared_storage.adoc—:page-aliases:typo (clsutered) leaves the pre-move URL without a redirect.windows-network-drive_configuration.adoc—nt authority\systemwas changed to the invalidauthority\system.
Minor (worth fixing while in these files):
- "teh" typo in
enterprise_only_auth.adoc;`tue`→`true`in theadmin_audit.adoctable;[source,.env]/ stale[source,php]language tags on converted env-var blocks.
Details and suggested fixes are in the line comments.
| 'logfile' => '/var/www/owncloud/data/admin_audit.log' | ||
| ] | ||
| ] | ||
| OWNCLOUD_LOG_CONDITIONS=[{"apps":["files_external"],"loglevel":0,"logfile":'/mnt/data/files/admin_audit.log'}] |
There was a problem hiding this comment.
Wrong app value and invalid JSON in this copyable example. This section is about redirecting the Auditing (admin_audit) app's log (the old config was 'apps' => ['admin_audit']), but the value here filters "apps":["files_external"] — so a user pasting this gets no audit-log redirection at all. It looks copied from the generic files_external example and never re-specialized.
Also, the JSON is invalid: the keys and the apps value use double quotes, but the logfile value is single-quoted ('/mnt/data/files/admin_audit.log'). Single quotes aren't valid JSON, so the condition won't parse.
Suggested:
OWNCLOUD_LOG_CONDITIONS=[{"apps":["admin_audit"],"loglevel":0,"logfile":"/mnt/data/files/admin_audit.log"}]
There was a problem hiding this comment.
Wrong app value and invalid JSON in this copyable example. This section is about redirecting the Auditing (
admin_audit) app's log (the old config was'apps' => ['admin_audit']), but the value here filters"apps":["files_external"]— so a user pasting this gets no audit-log redirection at all. It looks copied from the genericfiles_externalexample and never re-specialized.
this part if not correct ....
|
|
||
| .Figure 1. Metrics System Overview | ||
| image:enterprise/reporting/metrics/metrics-system.png[Metrics System Overview] | ||
| [width=100%,cols="50%,50%,options="header"] |
There was a problem hiding this comment.
Malformed table header — missing closing quote breaks the table. The cols attribute quote is never closed, so the attribute list is invalid and the two-column Metrics System/User image table won't render as a table.
Should be:
[width=100%,cols="50%,50%",options="header"]
| Path to custom scripts that need to be executed before an ownCoud installation command. | ||
| - `OWNCLOUD_PRE_SERVER_PATH=/etc/pre_server.d` + | ||
| Path to custom scripts that need to be executed before an ownCloud server startup. | ||
| - `\{OWNCLOUD_PROTOCOL=http` + |
There was a problem hiding this comment.
Garbled variable name. `\{OWNCLOUD_PROTOCOL=http` renders literally as \{OWNCLOUD_PROTOCOL=http — the variable name is replaced by escape junk. Should be:
- `OWNCLOUD_PROTOCOL=http` +
| Path to a custom `openssl.cnf` file, e.g. when using a custom PKI or CA in the container (see xref:configuration/server/config_sample_php_parameters.adoc#define-the-default-cipher-for-encrypting-files[documentation]). | ||
| - `OWNCLOUD_OPERATION_MODE=` + | ||
| Define ownCloud operation modes (see xref:configuration/server/config_sample_php_parameters.adoc#define-owncloud-operation-modes[documentation]). | ||
| - `OWNCLOUD_OVERWRITE_CLI_URL=\${\{OWNCLOUD_PROTOCOL}://\$\{OWNCLOUD_DOMAIN}$\{OWNCLOUD_SUB_URL}` + |
There was a problem hiding this comment.
Doubled brace in the default value. \${\{OWNCLOUD_PROTOCOL} renders as ${{OWNCLOUD_PROTOCOL} with a spurious double open-brace, misrepresenting the real default. The escaping is also inconsistent across the three segments (\${\{, \$\{, $\{). Should render as:
${OWNCLOUD_PROTOCOL}://${OWNCLOUD_DOMAIN}${OWNCLOUD_SUB_URL}
i.e. use the same $\{NAME} escaping for all three segments.
| Time to wait for a successful connection to the redis service on container startup. | ||
| - `OWNCLOUD_REDIS_TIMEOUT=` + | ||
| Sets the redis timeout value (see xref:configuration/server/config_sample_php_parameters.adoc#define-redis-cluster-connection-details[documentation]). | ||
| - `OWNCLOUD_REDIS_TLS_ALLOW_SELF_SIGNED=` + |
There was a problem hiding this comment.
Markdown link syntax will not render as a link. This entry (and all 10 OWNCLOUD_REDIS_TLS_* entries) uses (see [phpredis docs](https://github.com/phpredis/phpredis[documentation]). — Markdown [text](url) mixed with a nested AsciiDoc macro. It renders with the literal text [phpredis docs](, the intended "phpredis docs" label dropped, and an unbalanced-looking paren.
Use AsciiDoc link syntax, e.g.:
(see the https://github.com/phpredis/phpredis[phpredis docs]).
Applies to all OWNCLOUD_REDIS_TLS_* entries.
| :toc: right | ||
| :toclevels: 2 | ||
| :keywords: cluster, shared storage, nfs, kubernetes, swarm, scale-out, redis, locking, chown | ||
| :page-aliases: installation/deployment_recommendations/clsutered_shared_storage.adoc |
There was a problem hiding this comment.
Misspelled page-alias → dead redirect. clsutered is a typo for clustered. The real pre-move URL was .../deployment_recommendations/clustered_shared_storage, so as written no redirect is emitted for it and existing bookmarks/SEO break. (yarn validate won't catch this since nothing links to the misspelled path.) Fix:
:page-aliases: installation/deployment_recommendations/clustered_shared_storage.adoc
| [TIP] | ||
| ==== | ||
| Some groups, such as `everyone` might not be handled properly. This is because such groups don't exist in the LDAP server, or might not be found if the domain is different, such as `nt authority\system` or `builtin\domain-users`. | ||
| Some groups, such as `everyone` might not be handled properly. This is because such groups don't exist in the LDAP server, or might not be found if the domain is different, such as `authority\system` or `builtin\domain-users`. |
There was a problem hiding this comment.
Dropped nt prefix makes the account name wrong. This changed nt authority\system → authority\system. NT AUTHORITY\SYSTEM is the real Windows well-known account; authority\system is not a valid domain\account, so the example is now factually incorrect. Restore nt authority\system.
| * The password will be fetched from a key inside the config.php file. + | ||
| For details see the section below. Even if the account doesn't have a password like OAuth or OpenIDConnect, etc., the connection with the storage will use the password from config.php. | ||
| * The password will be fetched from a key inside the configuration file. + | ||
| For details see the section below. Even if the account doesn't have a password like OAuth or OpenIDConnect, etc., the connection with the storage will use the password from teh configuration file. |
There was a problem hiding this comment.
Typo introduced on this added line: "the connection with the storage will use the password from teh configuration file." → "from the configuration file".
|
|
||
| | `success` | ||
| | boolean | ||
| | If the request was successful `tue` or `false` |
There was a problem hiding this comment.
Typo `tue` → `true` in the public_link_accessed table ("If the request was successful tue or false"). Pre-existing, but this cell is being reformatted here — cheap to fix while touching it.
| To configure the WOPI app in your ownCloud installation, add the following configuration to `config/config.php`, and adjust it based on the details of your setup: | ||
| To configure the WOPI app in your ownCloud installation, add the following environment variables, adjusting them as necessary based on the details of your setup: | ||
|
|
||
| [source,php,subs="post_replacements,attributes+"] |
There was a problem hiding this comment.
Source language no longer matches content. This block is still tagged [source,php,subs="post_replacements,attributes+"] but its body was converted to environment variables with # shell-style comments. The php highlighter no longer fits. Separately, the [source,.env] used in the converted blocks throughout this PR isn't a recognized highlighter language — prefer ini (or bash) for env-var blocks.
- 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>
37727f9 to
a5c99c5
Compare
This PR adds more required changes for the OC11 docs