Skip to content

GH-35545: [R] Re-organise reference page on pkgdown site - #36171

Merged
thisisnic merged 3 commits into
apache:mainfrom
thisisnic:GH-35545_pkgdown
Jun 28, 2023
Merged

GH-35545: [R] Re-organise reference page on pkgdown site#36171
thisisnic merged 3 commits into
apache:mainfrom
thisisnic:GH-35545_pkgdown

Conversation

@thisisnic

@thisisnicthisisnic commented Jun 20, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

@thisisnicthisisnic changed the title [WIP] GH-35545: [R] Re-organise reference page on pkgdown site GH-35545: [R] Re-organise reference page on pkgdown site [WIP] Jun 20, 2023
@apacheapache deleted a comment from github-actionsBotJun 20, 2023
@thisisnic

thisisnic commented Jun 22, 2023

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

github-actionsBot commented Jun 22, 2023

Copy link
Copy Markdown

Revision: da23cd7d4cc70381f23a87ec54d8eeb286050a16

Submitted crossbow builds: ursacomputing/crossbow @ actions-f107541b2e

TaskStatus
preview-docsGithub Actions

@thisisnic

thisisnic commented Jun 22, 2023

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

github-actionsBot commented Jun 22, 2023

Copy link
Copy Markdown

Revision: a616732afe462e0220e964197cb458f963638010

Submitted crossbow builds: ursacomputing/crossbow @ actions-4ce99de976

TaskStatus
preview-docsGithub Actions

@thisisnicthisisnic mentioned this pull request Jun 23, 2023
Closed
@thisisnic

thisisnic commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

We'll need #36230 to merge before we can build these previews

@thisisnic
thisisnicforce-pushed the GH-35545_pkgdown branch 2 times, most recently from d7dcb3a to 8a33c11CompareJune 23, 2023 15:07
@thisisnic
Separate out R6 classes for multi-file datasets section
305cf5b
@thisisnic
Reorder to group similar items
58a6423
Split our reading/writing files sections
Move read_message to Input/Output section
Add aliases for acero to computation section
More reordering
Sort out alignment
Re-organise sections some more
Reorder some sections
Combine more sections
@thisisnicthisisnic changed the title GH-35545: [R] Re-organise reference page on pkgdown site [WIP] GH-35545: [R] Re-organise reference page on pkgdown siteJun 27, 2023
@thisisnic

thisisnic commented Jun 27, 2023

Copy link
Copy Markdown
MemberAuthor

There's more I want to on this, but I'd prefer to get the structure in place and follow up in later PRs, as it requires separating out the R6 class docs from the helper function docs, and this PR will be huge if I do this here.

@thisisnic
thisisnic marked this pull request as ready for review June 27, 2023 19:15
@thisisnic

thisisnic commented Jun 27, 2023

Copy link
Copy Markdown
MemberAuthor

To build this locally for review, it's best to delete all the contents of the articles directory, comment out the articles section in the .yml file here, and then run pkgdown::build_site(examples = FALSE, lazy = TRUE, install = FALSE, new_process = FALSE).

paleolimbot
paleolimbot approved these changes Jun 28, 2023
View reviewed changes

@paleolimbotpaleolimbot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a great improvement! (I couldn't get the docs to build locally even with your workaround; however, agreed that it's a battle for another day).

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jun 28, 2023
@thisisnic
thisisnic merged commit e2d21c1 into apache:mainJun 28, 2023
@conbench-apache-arrow

conbench-apache-arrowBot commented Jul 2, 2023

Copy link
Copy Markdown

Conbench analyzed the 6 benchmark runs on commit e2d21c16.

There were 6 benchmark results indicating a performance regression:

The full Conbench report has more details.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@paleolimbotpaleolimbotpaleolimbot approved these changes

Assignees

No one assigned

Labels

awaiting mergeAwaiting mergeComponent: R

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[R] Re-organise reference page on pkgdown site

2 participants

@thisisnic@paleolimbot