djnavarro opened a new pull request, #14514: URL: https://github.com/apache/arrow/pull/14514
This pull request proposes a number of changes to the pkgdown site for the R package: - Reduces the content on the README page to the essential points - Rewrites the "get started" page to focus on common tasks and novice users - Moves discussion of the Arrow data object hierarchy to a new "data objects" vignette - Moves discussion of Arrow data types and conversions to a new "data types" vignette - Moves discussion of schemas and storage of R attributes to a new "metadata" vignette - Moves discussion of package naming conventions to a new "package conventions" vignette - Moves discussion of read/write capabilities to a new "reading and writing data" vignette - Moves discussion of the dplyr back end to a new "data wrangling" vignette - Edits the "multi-file data sets" vignette to improve readability and to minimize risk of novice users unintentionally downloading the 70GB NYC taxi data by copy/paste errors - Minor edits to the "python" vignette to improve readability - Minor edits to the "cloud storage" vignette to improve readability - Minor edits to the "flight" vignette to improve readability - Inserts a new "data object layout" vignette (in the developer vignettes) to bridge between the R documentation and the Arrow specification page In addition there are some structural changes: - Some vignette filenames have been edited and links updated - The pkgdown template now uses bootstrap 5 - The developer vignettes are now in the main vignettes folder - The articles menu organizes the vignettes into meaningful categories - The former "project docs" menu has been replaced with a sidebar on the main page Possible issues as yet unaddressed: - I have not yet checked whether the bootstrap 5 template breaks the script inserting the documentation versions switcher - Changes to developer vignettes are extremely minimal in comparison to other vignettes. I'm uncertain whether to make further changes there or to defer that to a later PR - The "articles" menu currently hides all the developer vignettes under the "more articles" link: they should be made more prominent and easy to find - Some topics may not be described as well as we'd like? It is still a work-in-progress but feedback is appreciated. To make it easy to preview the proposed changes, a preview copy of the built documentation is posted here: https://djnavarro.net/draft-arrow-docs/ -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
