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.
- 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
| 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. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
Re-review @
|
Co-authored-by: Phil Davis <phil@jankaritech.com>
Re-review @
|
|
The comment in |
Re-review @
|
phil-davis
left a comment
There was a problem hiding this comment.
Text is looking clean from my point-of-view.
I will let Claude look after the analysis of dangling links etc.
Re-review @
|
Grammar & typo pass @
|
| 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 thekvnotool 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— recurringthe … files identifier(should befile's),The path of shared item(missingthe),contains to following keys(→the following),contains following keys(missingthe),The full path to the create file(→created).ldap_home_connector_configuration.adoc—according your setup(missingto).windows-network-drive_configuration.adoc—if you setup WND(verb →set up),the lock will timeout(verb →time out).ransomware-protection.adoc—rollback user dataused 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
|
Claude, I have reviewed your comment #1557 (comment) |
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>
This PR adds more required changes for the OC11 docs