search

apache / arrow

Apache Arrow is the universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics
https://arrow.apache.org/
Apache License 2.0
14.62k stars 3.55k forks source link

[Release] Build and publish R/Java/JS docs #21945

Closed asfimport closed 4 years ago

asfimport commented 5 years ago

Edit: this ticket was originally just about adding the R package docs, but it seems that the JS and Java docs aren't getting built as part of the release process anymore, so that needs to be fixed.

 

Original description:

https://issues.apache.org/jira/browse/ARROW-5452 added the R pkgdown site config. Adding the wiring into the apidocs build scripts was deferred because there was some discussion about which workflow was supported and which was deprecated.  

Uwe says: "Have a look at https://github.com/apache/arrow/blob/master/docs/Dockerfile and https://github.com/apache/arrow/blob/master/ci/docker_build_sphinx.sh Add that and a docs-r entry in the main docker-compose.yml should be sufficient to get it running in the docker setup. But actually I would rather like to see that we also add the R build to the above linked files."

Reporter: Neal Richardson / @nealrichardson Assignee: Krisztian Szucs / @kszucs

Note: This issue was originally created as ARROW-5497. Please see the migration documentation for further details.

asfimport commented 5 years ago

Neal Richardson / @nealrichardson: @xhochy (bringing discussion over here from the old PR): maybe I'm missing it, but I don't see in those where the Java and JS docs get built and added to the site. That sounds like the part of the process where the R docs need to be added.

asfimport commented 5 years ago

Uwe Korn / @xhochy: I'm not sure whether JS and Java docs currently get build at all. The gen_apidocs broke at some time and the solution was to migrate everything to the main docker-compose.yml but just hasn't happened yet.

asfimport commented 5 years ago

Neal Richardson / @nealrichardson: I see. https://github.com/apache/arrow-site/tree/asf-site/docs shows that neither were built with the 0.13 release. 

I'll broaden the scope of this ticket to fix all three in the preferred docker setup.

asfimport commented 5 years ago

Wes McKinney / @wesm: I moved this out of 0.14 so it's not distracting to me or @kou, this can get resolved after an RC is cut

asfimport commented 4 years ago

Neal Richardson / @nealrichardson: @kszucs is this covered by your other work on docs?

asfimport commented 4 years ago

Krisztian Szucs / @kszucs: @nealrichardson

 

https://arrow.apache.org/docs/r/

https://arrow.apache.org/docs/java/

https://arrow.apache.org/docs/js/

The release process generates them, but I'm not sure that we have proper references to them.

asfimport commented 4 years ago

Neal Richardson / @nealrichardson: There are links to all of those in the main site header