You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/10/26 22:20:23 UTC

[GitHub] [arrow] nealrichardson commented on pull request #14514: ARROW-17887: [R][Doc][WIP] Improve readability of the Get Started and README pages

nealrichardson commented on PR #14514:
URL: https://github.com/apache/arrow/pull/14514#issuecomment-1292725903

   This is great, thank you for taking this on. I'll give the content a close read at some point, but a couple of quick considerations:
   
   * We should be careful about changing the vignette filenames since they map to URLs and URLs make up an API. For some of the lesser vignettes it's maybe not a big deal, but the number of links to `vignette("install")` i.e. https://arrow.apache.org/docs/r/articles/install.html I've made out in the internet (and including twice in our own `r/configure`) make me wary of changing that one in particular.
   * We also should avoid adding .pngs to the R package tarball. We're already at 4.7mb without this change (I only know that because I noticed today when doing the CRAN submission) and the CRAN limit is 5mb. I don't know what the right pkgdown way of handling these extra documents is, but we should do that. We basically are trying to populate the website and don't really care if all of these vignettes ship in the package itself.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org