Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-41179: [Docs] Documentation for Dissociated IPC Protocol #41180

Merged
merged 30 commits into from
May 9, 2024

Conversation

zeroshade
Copy link
Member

@zeroshade zeroshade commented Apr 12, 2024

Rationale for this change

Adding documentation for the Experimental Dissociated IPC Protocol for splitting arrow IPC metadata and body data into separate streams for use with newer transports such as UCX and Libfabric.

The relevant mailing list discussion and vote: https://lists.apache.org/thread/k26n1h90b1wy1w5k53whh0t8o4nd0yx7

What changes are included in this PR?

Only documentation changes and images for the Arrow docs site.

I tagged people I thought might be relevant for reviewing, but feel free to tag and add anyone else that might seem relevant to reviewing this. Thanks!

@zeroshade zeroshade marked this pull request as ready for review April 12, 2024 22:12
Copy link

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

@kou
Copy link
Member

kou commented Apr 13, 2024

@github-actions crossbow submit preview-docs

Copy link

Revision: f3ee24f

Submitted crossbow builds: ursacomputing/crossbow @ actions-a3aa4ae88d

Task Status
preview-docs GitHub Actions

docs/source/format/DissociatedIPC/ClientFlowchart.mmd.svg Outdated Show resolved Hide resolved
docs/source/format/DissociatedIPC.rst Outdated Show resolved Hide resolved
docs/source/format/DissociatedIPC.rst Outdated Show resolved Hide resolved
docs/source/format/DissociatedIPC.rst Outdated Show resolved Hide resolved
docs/source/format/DissociatedIPC.rst Outdated Show resolved Hide resolved
docs/source/format/DissociatedIPC.rst Outdated Show resolved Hide resolved
@github-actions github-actions bot added awaiting review Awaiting review awaiting changes Awaiting changes and removed awaiting review Awaiting review awaiting committer review Awaiting committer review labels Apr 13, 2024
@kou
Copy link
Member

kou commented Apr 13, 2024

http://crossbow.voltrondata.com/pr_docs/41180/format/DissociatedIPC.html

We may need this:

diff --git a/docs/source/format/index.rst b/docs/source/format/index.rst
index 856830d863..44ea3e8e7e 100644
--- a/docs/source/format/index.rst
+++ b/docs/source/format/index.rst
@@ -30,6 +30,7 @@ Specifications
    CDataInterface
    CStreamInterface
    CDeviceDataInterface
+   DissociatedIPC
    Flight
    FlightSql
    ADBC

@zeroshade
Copy link
Member Author

@github-actions crossbow submit preview-docs

@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Apr 15, 2024
Copy link

Only contributors can submit requests to this bot. Please ask someone from the community for help with getting the first commit in.
The Archery job run can be found at: https://github.com/apache/arrow/actions/runs/8694645472

@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Apr 15, 2024
@zeroshade
Copy link
Member Author

@kou @assignUser Do i need to be added to a different list for crossbow to recognize me? 😄

@assignUser
Copy link
Member

You have to set your Apache membership to public for it to recognize you

@zeroshade
Copy link
Member Author

@github-actions crossbow submit preview-docs

Copy link

Revision: 88bd4ad

Submitted crossbow builds: ursacomputing/crossbow @ actions-363b170c21

Task Status
preview-docs GitHub Actions

@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels May 9, 2024
@zeroshade zeroshade merged commit 1c62df5 into apache:main May 9, 2024
6 checks passed
@zeroshade zeroshade removed the awaiting change review Awaiting change review label May 9, 2024
@zeroshade zeroshade deleted the dissociated-ipc-doc branch May 9, 2024 19:17
Copy link

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

None of the specified runs were found on the Conbench server.

The full Conbench report has more details.

vibhatha pushed a commit to vibhatha/arrow that referenced this pull request May 25, 2024
…ache#41180)

### Rationale for this change
Adding documentation for the Experimental Dissociated IPC Protocol for splitting arrow IPC metadata and body data into separate streams for use with newer transports such as UCX and Libfabric.

The relevant mailing list discussion and vote: https://lists.apache.org/thread/k26n1h90b1wy1w5k53whh0t8o4nd0yx7

### What changes are included in this PR?
Only documentation changes and images for the Arrow docs site.

I tagged people I thought might be relevant for reviewing, but feel free to tag and add anyone else that might seem relevant to reviewing this. Thanks!
* GitHub Issue: apache#41179

Lead-authored-by: Matt Topol <zotthewizard@gmail.com>
Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
Signed-off-by: Matt Topol <zotthewizard@gmail.com>
JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request May 29, 2024
…ache#41180)

### Rationale for this change
Adding documentation for the Experimental Dissociated IPC Protocol for splitting arrow IPC metadata and body data into separate streams for use with newer transports such as UCX and Libfabric.

The relevant mailing list discussion and vote: https://lists.apache.org/thread/k26n1h90b1wy1w5k53whh0t8o4nd0yx7

### What changes are included in this PR?
Only documentation changes and images for the Arrow docs site.

I tagged people I thought might be relevant for reviewing, but feel free to tag and add anyone else that might seem relevant to reviewing this. Thanks!
* GitHub Issue: apache#41179

Lead-authored-by: Matt Topol <zotthewizard@gmail.com>
Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
Signed-off-by: Matt Topol <zotthewizard@gmail.com>
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.

8 participants