[jira] [Comment Edited] (JCR-4732) Host JCR 2.0 spec and its javadoc below https://jackrabbit.apache.org

["Konrad Windszus (Jira)" <ji...@apache.org>]

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

Konrad Windszus edited comment on JCR-4732 at 11/5/21, 7:57 AM:
----------------------------------------------------------------

I assume so (will try it out later), but I was more thinking about the links used on Jackrabbit/Oak the website. I just established:
# https://s.apache.org/jcr-2.0-javadoc and
# https://s.apache.org/jcr-2.0-spec
# https://s.apache.org/jcr-1.0-spec
Will do some more tests with those links and then propose PRs/patches for documentation/pom.xml updates.




was (Author: kwin):
I assume so (will try it out later), but I was more thinking about the links used on Jackrabbit/Oak the website. I just established:
# https://s.apache.org/jcr-2.0-javadoc and
# https://s.apache.org/jcr-2.0-spec

Will do some more tests with those links and then propose PRs/patches for documentation/pom.xml updates.



> Host JCR 2.0 spec and its javadoc below https://jackrabbit.apache.org
> ---------------------------------------------------------------------
>
>                 Key: JCR-4732
>                 URL: https://issues.apache.org/jira/browse/JCR-4732
>             Project: Jackrabbit Content Repository
>          Issue Type: Improvement
>          Components: docs
>            Reporter: Konrad Windszus
>            Priority: Major
>
> The only reliable online hosting location of the JCR 2.0 specification and its javadoc has been Day/Adobe (apart from JSR which only provides the spec as zipped archive). As the URLs changed quite often from
> # http://www.day.com/specs/jcr/2.0/ (broken)
> # https://docs.adobe.com/content/docs/en/spec/jcr/2.0/ (redirected)
> # https://docs.adobe.com/docs/en/spec/jcr/2.0/
> # https://www.adobe.io/experience-manager/reference-materials/spec/jcr/2.0/index.html (seems to be the current one for JCR 2.0 spec)
> and
> # http://www.day.com/specs/javax.jcr/javadocs/jcr-2.0/ (broken)
> # http://www.day.com/maven/javax.jcr/javadocs/jcr-2.0/ (broken)
> # https://docs.adobe.com/content/docs/en/spec/jsr170/javadocs/jcr-2.0/
> # https://docs.adobe.com/docs/en/spec/jsr170/javadocs/jcr-2.0/
> # https://docs.adobe.com/docs/en/spec/javax.jcr/javadocs/jcr-2.0/
> # https://www.adobe.io/experience-manager/reference-materials/spec/javax.jcr/javadocs/jcr-2.0/
> # https://www.adobe.io/experience-manager/reference-materials/spec/jsr170/javadocs/jcr-2.0/
> We maintain a lot of references towards it in our documentation, instead of adjusting the URLs each time, we should host that in our own ASF website under a stable URL.
> The download from http://jcp.org/aboutJava/communityprocess/final/jsr283/index.html only contains a Word document and a PDF of the spec though, so one needs to somehow convert to html. 
> Although hosting the javadoc is straightforward it might be nice to apply some fixes (e.g. unclosed code tag in https://www.adobe.io/experience-manager/reference-materials/spec/jsr170/javadocs/jcr-2.0/javax/jcr/Session.html#getNodeByIdentifier(java.lang.String)).



--
This message was sent by Atlassian Jira
(v8.3.4#803005)