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

Update object_store release documentation #6565

Merged
merged 8 commits into from
Oct 16, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Oct 15, 2024

Which issue does this PR close?

Part of #6183 (potentially moving object_store to its own repo)

Rationale for this change

While working on #6263 I figured I would take the time to start preparing for a separte repo too by making a separate release documentation

What changes are included in this PR?

  1. Remove object_store references from dev/release/README.md
  2. Make object_store specific documentation in object_store/dev/release/README.md

Are there any user-facing changes?

No, this is likely only applicable to a handful of people

@alamb alamb added the development-process Related to development process of arrow-rs label Oct 15, 2024
@github-actions github-actions bot added the object-store Object Store Interface label Oct 15, 2024
@@ -1,40 +0,0 @@
#!/bin/bash
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't use this script and its presence in the repo and instructions I think is confusing


1. The "Rust Arrow Crates": `arrow`, `arrow-flight`, `parquet`, and `parquet-derive`.
2. The `object_store` crate.
This file documents the release process for the "Rust Arrow Crates": `arrow`, `arrow-flight`, `parquet`, and `parquet-derive`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed all references to object_store from this file

@@ -17,4 +17,187 @@
under the License.
-->

See instructions in [`/dev/release/README.md`](../../../dev/release/README.md)

# Release Process
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved the relevant content for object store here -- it is somewhat redundant with arrow-rs but I think that is ok as it is much clearer (and will be required if/when we move to a new repo)

@alamb alamb changed the title Update object_store release documentation Update object_store release documentation Oct 15, 2024
@alamb alamb marked this pull request as ready for review October 15, 2024 22:26
@alamb alamb added the documentation Improvements or additions to documentation label Oct 15, 2024
@alamb alamb merged commit 7900b4d into apache:master Oct 16, 2024
14 checks passed
@alamb
Copy link
Contributor Author

alamb commented Oct 16, 2024

Thanks @tustvold

@alamb alamb deleted the alamb/update_release_docs branch October 16, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development-process Related to development process of arrow-rs documentation Improvements or additions to documentation object-store Object Store Interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants