Skip to content

GH-46475: [Documentation][C++][Compute] Consolidate Acero developer docs #46476

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

zanmato1984
Copy link
Contributor

@zanmato1984 zanmato1984 commented May 16, 2025

What changes are included in this PR?

  1. Move current Acero Developer's Guild under user doc to where under developer docs;
  2. Make it the main doc enclosing elaborating docs like Swiss table.

Are these changes tested?

No need.

Are there any user-facing changes?

None.

Copy link

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note this is renamed from "streaming_execution.rst" to "acero.rst" which is more explicit (and shorter). Because "Acero" has become a much more well-known name I assume.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is moved from "docs/source/cpp/acero/developer_guide.rst" with two small tweaks:

  1. Changing the title from "Developer’s Guide" to "Developing Acero" (which is more aligned with the naming of other docs at the same level).
  2. Adding the "Others" section at the bottom as a TOC to enclose sub-docs which are too elaborate to be inlined (currently only swiss_table.rst).

Please note the original "acero.rst" was moved to "acero/swiss_table.rst" (I was thinking about inlining it however found it too long), but git doesn't recognize this pattern and shows many diffs. The actual changes are just the two places mentioned above.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As mentioned in other comment, this is renamed from "developers/cpp/acero.rst".

@github-actions github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels May 16, 2025
@zanmato1984
Copy link
Contributor Author

@github-actions crossbow submit preview-docs

Copy link

Revision: 3685f4d

Submitted crossbow builds: ursacomputing/crossbow @ actions-9fea3f3368

Task Status
preview-docs GitHub Actions

@zanmato1984
Copy link
Contributor Author

There we go.

User doc: before, after (preview).

Dev doc: before (no Acero yet), after (preview).

@raulcd @amoeba @pitrou PTAL. Thanks.

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.

1 participant