Skip to content

hint at desktop client#144

Open
jnweiger wants to merge 2 commits into
masterfrom
jnweiger-patch-1
Open

hint at desktop client#144
jnweiger wants to merge 2 commits into
masterfrom
jnweiger-patch-1

Conversation

@jnweiger

Copy link
Copy Markdown
Contributor

Some Linux users are desperately seeking a way to sync and come here, instead to https://owncloud.com/desktop-app

Some Linux users are desperately seeking a way to sync and come here, instead to https://owncloud.com/desktop-app
@jnweiger jnweiger requested a review from mmattel July 25, 2023 14:19

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

🤖 Automated review by Claude Code review agent.

Overview

This is a small, well-intentioned documentation change to modules/classic_ui/pages/files/access_webdav.adoc. It amends the intro sentence of the "Accessing Files Using Linux" section so that, before listing WebDAV-based file-manager methods, it reminds Linux users that a desktop client also exists. The motivation (per the PR description) is that Linux users looking to sync land on this WebDAV page rather than the desktop app, so a pointer toward the sync client is genuinely useful.

The diff is a single-line replacement (+1/-1), AsciiDoc syntax is untouched, and the change builds cleanly with no new attributes, xrefs, or images. No broken links introduced.

Code quality / style

  • AsciiDoc syntax: clean. The edit only touches prose within a paragraph; the line continues onto the following methods. line, which is preserved, so paragraph flow is intact.
  • The sentence reads slightly awkwardly: "you can access files in the Linux operating systems". The original was "in Linux operating systems" (no article). Adding "the" before "Linux operating systems" is grammatically off — recommend keeping it as "in Linux operating systems" or rephrasing to "on Linux".

Specific suggestions

  1. Link the mention of the desktop client. The PR's stated goal is to guide users to the desktop app, but the new text says "a desktop client" as plain prose with no link. This same page already documents the client higher up:

    • Section "ownCloud Desktop and Mobile Clients" (near the top of this file) links to https://owncloud.com/desktop-app/[ownCloud Desktop Client].
      Consider making the hint actionable, e.g.:
    In addition to using the xref:#owncloud-desktop-and-mobile-clients[ownCloud Desktop Client], you can access files in Linux operating systems using the following methods.

    or, if an in-page anchor isn't desired, reuse the existing external link:

    In addition to using the https://owncloud.com/desktop-app/[ownCloud Desktop Client], you can access files in Linux operating systems using the following methods.

    As written, a user who skipped the top of the page still has no clickable path to the sync client — which is precisely the audience the PR targets.

  2. Grammar: drop the article — "you can access files in Linux operating systems" (matching the original) reads better than "in the Linux operating systems".

  3. Capitalization/consistency: the rest of the file uses "ownCloud Desktop Client" (capitalized, branded). The lowercase generic "a desktop client" is fine for a hint, but linking it (suggestion 1) would also align terminology.

Potential issues / risks

  • Low risk overall — prose-only change, no structural/link/build impact.
  • The only real shortcoming is that the change describes a desktop client without pointing to one, so it only partially achieves the PR's goal. Adding a link (suggestion 1) would close that gap and is the single change I'd recommend before merge.
  • No broken xrefs, no missing attribute references, no image changes.

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