jackrabbit-oak-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Marcel Reutegger (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OAK-7693) [DirectBinaryAccess] Documentation
Date Mon, 13 Aug 2018 07:14:00 GMT

    [ https://issues.apache.org/jira/browse/OAK-7693?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16577900#comment-16577900
] 

Marcel Reutegger commented on OAK-7693:
---------------------------------------

bq. Should I update the above statement then? If yes, what is a good way to describe the different
cases, list all of them?

Yes, please. How about a list of methods that do not support the feature?

bq. Will Oak 1.10 be the "official" release this feature is expected to be in? The doc states
{{@since Oak 1.10}} and I wasn't sure if that can mention the unstable releases, e.g. 1.9.x
currently.

1.9.x releases are also official releases but considered unstable. The Oak documentation is
not that consistent with a new feature and the version it was introduced. In some cases an
unstable release is referenced when the feature first appeared. Sometimes the first stable
release is referenced. I have a slight preference for mentioning stable releases only in the
documentation.

bq. When should we publish to the documentation site?

We usually publish the documentation as soon as it is ready in trunk and mention the version
when the feature is available. 

> [DirectBinaryAccess] Documentation
> ----------------------------------
>
>                 Key: OAK-7693
>                 URL: https://issues.apache.org/jira/browse/OAK-7693
>             Project: Jackrabbit Oak
>          Issue Type: Technical task
>          Components: doc
>            Reporter: Marcel Reutegger
>            Assignee: Alexander Klimetschek
>            Priority: Minor
>             Fix For: 1.10
>
>
> Add official Oak documentation for the direct binary access feature.
> There's a [wiki page|https://wiki.apache.org/jackrabbit/Direct%20Binary%20Access] that
already describes the feature, but official documentation should be created in the oak-doc
module.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message