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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GH-46582: [Docs] Update docs to match main site and link to other repos by thisisnic · Pull Request #46583 · apache/arrow · GitHub
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

@thisisnicthisisnic 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
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

Revision: 32a0081

Submitted crossbow builds: ursacomputing/crossbow @ actions-d1602bad04

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actionsgithub-actionsBot 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

TaskStatus
preview-docsGitHub Actions

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

Copy link
Copy Markdown
MemberAuthor

@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
MemberAuthor

@github-actions crossbow submit preview-docs

@thisisnic
thisisnic requested a review from ianmcookMay 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

TaskStatus
preview-docsGitHub Actions

@ianmcook

Copy link
Copy Markdown
Member

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

Comment threaddocs/source/conf.py
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels May 26, 2025

@AlenkaFAlenkaF 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 threaddocs/source/conf.py
Comment threaddocs/source/index.rst
Comment threaddocs/source/libraries/index.rst Outdated
Comment threaddocs/source/index.rst
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 27, 2025
@thisisnic

Copy link
Copy Markdown
MemberAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 2973b9c

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

TaskStatus
preview-docsGitHub Actions

@thisisnic

Copy link
Copy Markdown
MemberAuthor

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
MemberAuthor

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

TaskStatus
preview-docsGitHub 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook requested a review from AlenkaFMay 28, 2025 00:28
@ianmcook

Copy link
Copy Markdown
Member

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

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

@AlenkaFAlenkaF 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

TaskStatus
preview-docsGitHub Actions

@ianmcook
ianmcook merged commit d7015bd into apache:mainMay 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 freeto 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

@thisisnic@ianmcook@AlenkaF