[ https://issues.apache.org/jira/browse/OAK-8696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16983063#comment-16983063 ]
Matt Ryan edited comment on OAK-8696 at 11/27/19 1:19 AM: ---------------------------------------------------------- [~alexander.klimetschek] I would prefer to keep the algorithm in one place so we don't have multiple copies to update if it ever changes. Is it acceptable to expose the link a bit more in the section where we talk about the second step of direct upload? For example, the documentation for that part currently says: {noformat} 2. **Upload:** The remote client performs the actual binary upload directly to the binary storage provider. The BinaryUpload returned from the previous call to `initiateBinaryUpload(long, int)` contains detailed instructions on how to complete the upload successfully. For more information, see the `BinaryUpload` documentation. {noformat} We could change it to something like: {noformat} 2. **Upload:** The remote client performs the actual binary upload directly to the binary storage provider. The BinaryUpload returned from the previous call to `initiateBinaryUpload(long, int)` contains detailed instructions on how to complete the upload successfully. For more information, see the [`BinaryUpload` documentation](http://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/api/binary/BinaryUpload.html). {noformat} WDYT? was (Author: mattvryan): [~alexander.klimetschek] I would prefer to keep the algorithm in one place so we don't have multiple copies to update if it ever changes. Is it acceptable to expose the link a bit more in the section where we talk about the second step of direct upload? For example, the documentation for that part currently says: {noformat} 2. **Upload:** The remote client performs the actual binary upload directly to the binary storage provider. The BinaryUpload returned from the previous call to `initiateBinaryUpload(long, int)` contains detailed instructions on how to complete the upload successfully. For more information, see the `BinaryUpload` documentation. {noformat} We could change it to something like: {noformat} 2. **Upload:** The remote client performs the actual binary upload directly to the binary storage provider. The BinaryUpload returned from the previous call to `initiateBinaryUpload(long, int)` contains detailed instructions on how to complete the upload successfully. For more information, see the [`BinaryUpload` documentation](http://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/api/binary/BinaryUpload.html). {noformat} WDYT? > [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)