[
https://issues.apache.org/jira/browse/OAK-8696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16983924#comment-16983924
]
Alexander Klimetschek commented on OAK-8696:
--------------------------------------------
Link is fine if it stays up to date.
However, to me as a developer using Oak, the javadoc is actually the place that
is duplicated (different versions, urls have changed and broke). To most
readers, only the published javadoc counts, not the source code. So I think
from the perspective of the readers the documentation page is the best central
place, also given that this is what a Google search for “oak direct binary” et
al. will surface first.
The algorithm description doesn’t really change much anymore and copy pasting
should be minimal effort whenever that might happen again - simply copy the
generated javadoc html into the markdown.
> [Direct Binary Access] upload algorithm documentation should also be on the
> website
> -----------------------------------------------------------------------------------
>
> Key: OAK-8696
> URL: https://issues.apache.org/jira/browse/OAK-8696
> Project: Jackrabbit Oak
> Issue Type: Bug
> Components: doc
> Reporter: Alexander Klimetschek
> Assignee: Matt Ryan
> Priority: Major
>
> The upload algorithm description that is currently a bit hidden in the
> javadocs of
> [https://github.com/apache/jackrabbit-oak/blob/trunk/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/binary/BinaryUpload.java]
> should also be included on the documentation site:
> [https://jackrabbit.apache.org/oak/docs/features/direct-binary-access.html]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
