Skip to content

GH-46582: [Docs] Update docs to match main site and link to other repos#46583

Merged
ianmcook merged 14 commits into
apache:mainfrom
thisisnic:match-site
May 28, 2025
Merged

GH-46582: [Docs] Update docs to match main site and link to other repos#46583
ianmcook merged 14 commits into
apache:mainfrom
thisisnic:match-site

Conversation

@thisisnic

@thisisnic thisisnic commented May 26, 2025

Copy link
Copy Markdown
Member

Rationale for this change

Updating docs site to more easily link to other repos

What changes are included in this PR?

Docs updates

Are these changes tested?

Nope

Are there any user-facing changes?

To the docs, aye

@thisisnic

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46582 has been automatically assigned in GitHub to PR creator.

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46582 has no components, please add labels for components.

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

Task Status
preview-docs GitHub Actions

@thisisnic

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@github-actions github-actions Bot added the awaiting review Awaiting review label May 26, 2025
@github-actions

Copy link
Copy Markdown

Revision: a4160a6

Submitted crossbow builds: ursacomputing/crossbow @ actions-b81b26dbb9

Task Status
preview-docs GitHub Actions

@thisisnic
thisisnic requested a review from AlenkaF May 26, 2025 10:41
@thisisnic

Copy link
Copy Markdown
Member Author

@ianmcook It's not possible to add "docs" and "source" dropdowns like on the main site using the current template, but I tried a different approach here to simplify the landing page. Let me know what you think.

@thisisnic

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcook May 26, 2025 10:42
@thisisnic
thisisnic marked this pull request as ready for review May 26, 2025 10:42
@github-actions

Copy link
Copy Markdown

Revision: a2c2b17

Submitted crossbow builds: ursacomputing/crossbow @ actions-5ae03d6066

Task Status
preview-docs GitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

I really like this approach; thanks @thisisnic! I'll add some comments later today.

Comment thread docs/source/conf.py
@github-actions github-actions Bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaF AlenkaF 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.

Thanks for the changes! This will make the docs nicer to move through.

Comment thread docs/source/conf.py
Comment thread docs/source/index.rst
Comment thread docs/source/libraries/index.rst Outdated
Comment thread docs/source/index.rst
@github-actions github-actions Bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
Member Author

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

Submitted crossbow builds: ursacomputing/crossbow @ actions-15d60c8255

Task Status
preview-docs GitHub Actions

@thisisnic

Copy link
Copy Markdown
Member Author

Thanks both for the feedback! I've renamed the heading back to "implementations" and for simplicity have moved those details back to the landing page.

@ianmcook

Copy link
Copy Markdown
Member

My 2 cents: I thought it was very nice having the table of Arrow implementations on their own separate page, like @thisisnic had in an earlier commit in this PR. But I understand your wish to keep the list of languages featured prominently on the main index page @AlenkaF. I think there's a good way to reconcile this:

How about we add two more cards to the grid on the main index page, so it looks like this?

Screenshot 2025-05-27 at 15 06 27

The Implementations link/button will go to a separate page (like Nic had before, but named "Implementations" instead of "Libraries"). The Cookbook button will link to the cookbooks page.

@thisisnic if you give me commit rights for your fork, I can push this.

@thisisnic

Copy link
Copy Markdown
Member Author

You should be able to push to this but let me know if you can't @ianmcook!

@ianmcook

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 0d1ffc6

Submitted crossbow builds: ursacomputing/crossbow @ actions-7e6f2ccd9e

Task Status
preview-docs GitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2e4b26f

Submitted crossbow builds: ursacomputing/crossbow @ actions-ce353801d3

Task Status
preview-docs GitHub Actions

@ianmcook
ianmcook requested a review from AlenkaF May 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

@AlenkaF let us know if this looks good to you!

@github-actions github-actions Bot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels May 28, 2025

@AlenkaF AlenkaF 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.

LGTM with only one last suggestion!

* - nanoarrow
- `nanoarrow Docs <https://arrow.apache.org/nanoarrow>`_
- `nanoarrow Source <http://github.com/apache/arrow-nanoarrow>`_

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.

Could we add a section for the Cookbooks here as well? It would be helpful to make them accessible from multiple locations.

Suggested change
C++ cookbook <https://arrow.apache.org/cookbook/cpp/>
Java cookbook <https://arrow.apache.org/cookbook/java/>
Python cookbook <https://arrow.apache.org/cookbook/py/>
R cookbook <https://arrow.apache.org/cookbook/r/>

As a list-table or as a normal list, not sure.

@ianmcook

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 7d050b7

Submitted crossbow builds: ursacomputing/crossbow @ actions-2119246738

Task Status
preview-docs GitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:main May 28, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit d7015bd.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants