[WIP] Link to OCIS Web UI docu#169
Conversation
|
I am not really confident about this as the webui docs is user centric and we do not reference in the ocis webui documentation to the ocis admin docs... |
DeepDiver1975
left a comment
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
Overview
This PR adds links pointing from the ownCloud Web UI docs to the OCIS (Infinite Scale) Web UI documentation in two places:
modules/ROOT/pages/index.adoc— adds a sentence linking toxref:owncloud_web:index.adocand to the Infinite Scale Web UI docs.modules/owncloud_web/pages/index.adoc— adds a bare URL pointing to the same Infinite Scale Web UI page.
It also tightens the existing classic UI sentence (removes a redundant "guide"). Small, focused change (+3 / -1, 2 files).
Note: this PR is explicitly marked [WIP], and the description lists open todos: "adoc syntax and backports ...". So the items below are largely the things the author already flagged as unfinished — treat this as not-yet-ready-to-merge.
Code quality / style
- The wording cleanup in
modules/ROOT/pages/index.adoc("...ownCloud Server UI] is only available...") reads better than before. Good. - The
xref:owncloud_web:index.adoc[ownCloud Web]reference is valid: theowncloud_webmodule exists andindex.adocis present, and this matches the existing convention used inmodules/owncloud_web/partials/nav.adoc. Good.
Specific suggestions
-
Broken external link (high priority). Both new links point to
https://doc.owncloud.com/ocis/deployment/webui/webui.html, which currently returns HTTP 404 (verified, including following redirects; the basedoc.owncloud.com/ocis/site itself returns 200, so this is a genuinely missing page, not a transient outage). The whole point of the PR is to link to this page, so the target URL needs to be corrected before merge. Please double-check the correct OCIS Web UI docs path. -
Bare URL vs. linked text. In
modules/owncloud_web/pages/index.adocthe link is added as a bare URL:For more information about owncloud Web on Infinite Scale see https://doc.owncloud.com/ocis/deployment/webui/webui.htmlFor consistency with the rest of the docs (and the other hunk in this same PR), give it link text, e.g.:
For more information, see the https://doc.owncloud.com/ocis/.../webui.html[ownCloud Web on Infinite Scale] documentation. -
Capitalization / typo. "owncloud Web" should be "ownCloud Web" to match the brand casing used everywhere else in these files.
-
Punctuation. The new sentence in
modules/owncloud_web/pages/index.adocis missing a trailing period. -
Comma usage. "available for both, ownCloud Server and ... Infinite Scale" — the comma after "both" is grammatically off. Prefer "available for both ownCloud Server and ... Infinite Scale".
Potential issues / risks
- Link rot / accuracy (primary risk): as noted, the destination 404s today. Merging as-is would ship two broken links into the published docs.
- Backports: the description mentions backports as a todo. If this content needs to land on release branches as well, that follow-up is still outstanding.
- AsciiDoc syntax: the bare-URL form will render as an auto-detected link, so it will not break the build, but it is stylistically inconsistent (per suggestion 2).
Otherwise the change is low-risk in scope. The main blocker is the broken target URL; the rest are minor polish items, most of which the author already anticipated with the WIP/todo note.
Suggest to add links in two places.
todo: adoc syntax and backports ...