Skip to content

fix(admin): prose quality fixes across admin manual (MED severity)#14643

Merged
skjnldsv merged 16 commits intomasterfrom
fix/admin-manual-med
Apr 27, 2026
Merged

fix(admin): prose quality fixes across admin manual (MED severity)#14643
skjnldsv merged 16 commits intomasterfrom
fix/admin-manual-med

Conversation

@miaulalala
Copy link
Copy Markdown
Contributor

Sixteen targeted prose fixes across the admin manual: corrected grammar, clearer
phrasing, fixed a malformed RST link, and improved technical accuracy.

Changes by area:

  • installation/: command_line_installation (use dedicated DB user in example), restore (add config files to required restore items), backup (separate two backup approaches
    clearly)
  • configuration_server/: oauth2 (word order: "does only support" → "supports only"), logging_configuration (standardise "messages" → "log entries")
  • configuration_files/: auth_mechanisms (rewrite misleading per-user file locking sentence), amazons3 (missing "to" in "give access your S3 mount")
  • configuration_user/: user_configuration ("have the the option", "will not longer"), user_auth_ldap (".e.g" → "e.g.", "according data" → "corresponding data", invalid regex
    [\a-\zA-\Z0-\9_.@-][a-zA-Z0-9_.@-])
  • occ/: occ_ldap ("Used to cleaning up" → "Used to clean up")
  • ai/: app_context_agent (clarify language caveat), eu_ai_act ("IBMwatsonX" → "IBM watsonx")
  • misc: windmill_workflows/index (malformed RST link + missing verb "have"), ManagingDeployDaemons ("or has exposed" → "or that has exposed"), office/installation (duplicate "see
    see"), office/example-docker ("For security reason" → "For security reasons,")

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

Using 'root' as the database user is a security antipattern.

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
The original note omitted config files, which are also required.

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
The previous sentence mixed two options into a confusing parenthetical.

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
The original sentence implied files are duplicated per user, which is misleading.
Rewritten to accurately describe the locking limitation.

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
"have the the option" → "have the option"
"will not longer be able" → "will no longer be able"

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
@miaulalala
Copy link
Copy Markdown
Contributor Author

/backport to stable33

".e.g" → "e.g.", "according data" → "corresponding data",
invalid regex notation [\a-\zA-\Z0-\9_.@-] → [a-zA-Z0-9_.@-]

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
…lows/index.rst

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
…eployDaemons.rst

AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
AI-Assisted-By: claude-sonnet-4-6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
@miaulalala miaulalala force-pushed the fix/admin-manual-med branch from acd1e24 to bc3a031 Compare April 26, 2026 21:46
@skjnldsv skjnldsv merged commit 1828335 into master Apr 27, 2026
23 checks passed
@skjnldsv skjnldsv deleted the fix/admin-manual-med branch April 27, 2026 06:01
@skjnldsv
Copy link
Copy Markdown
Member

skjnldsv commented May 1, 2026

/backport to stable32 please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants