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

[docs] Move file-based metastore doc to installation/deployment.rst #24620

Merged

Conversation

steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Feb 24, 2025

Description

Motivation and Context

After #24511 was merged, a discussion began that suggested that /connector/ was not the best place in the Presto documentation for the file-based metastore configuration. Further discussion settled on moving it adjacent to the Configure Hive Metastore topic in installation/deployment.rst.

Impact

Readers may be able to find the file-based metastore documentation easier in this new location.

Test Plan

Local doc builds. Screenshot of relocated text:
Screenshot 2025-02-24 at 2 18 09 PM

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== RELEASE NOTES ==

General Changes
* Add documentation for file-based Hive metastore to :doc:`/installation/deployment`.

@steveburnett steveburnett self-assigned this Feb 24, 2025
@steveburnett steveburnett requested review from elharo and a team as code owners February 24, 2025 21:14
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Feb 24, 2025
@prestodb-ci prestodb-ci requested review from a team, zuyu and bibith4 and removed request for a team February 24, 2025 21:14
@github-actions github-actions bot added the docs label Feb 24, 2025
Copy link
Member

@imjalpreet imjalpreet left a comment

Choose a reason for hiding this comment

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

@steveburnett Thank you! Just some minor nits.

I will let you know if I have any suggestions on the positioning of this within deployment.rst

@steveburnett steveburnett force-pushed the steveburnett-filebased-metastore2 branch from 2176bc1 to fd4ea79 Compare February 25, 2025 14:43
@steveburnett
Copy link
Contributor Author

@steveburnett Thank you! Just some minor nits.

I will let you know if I have any suggestions on the positioning of this within deployment.rst

Thanks @imjalpreet! Nits addressed, please re-review.

Copy link
Member

@agrawalreetika agrawalreetika left a comment

Choose a reason for hiding this comment

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

LGTM, apart from one minor suggestion

@steveburnett steveburnett force-pushed the steveburnett-filebased-metastore2 branch 2 times, most recently from ad80687 to e781c9c Compare February 25, 2025 16:09
@steveburnett steveburnett force-pushed the steveburnett-filebased-metastore2 branch from e781c9c to ea88ce1 Compare February 25, 2025 16:12
Copy link
Member

@imjalpreet imjalpreet left a comment

Choose a reason for hiding this comment

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

LGTM

@rschlussel
Copy link
Contributor

trying to understand the motivation here better. why is connector not the right place for this documentation, since it is a specific configuration option for a few connectors?

@imjalpreet imjalpreet merged commit 2a0999a into prestodb:master Feb 27, 2025
53 checks passed
@pratyakshsharma
Copy link
Contributor

@rschlussel It was not very intuitive for end users to search for this documentation under connectors list. Connectors list is intended for listing and describing all the supported connectors. The documentation for FileHiveMetastore was previously added as a separate page under connectors.
FileHiveMetastore can only be used with lakehouse connectors, we could add it with each of those connectors under the configuration (similar to https://prestodb.io/docs/current/connector/hudi.html#configuration) which would make it redundant in all of them. Since it is mostly used for development purposes, I think it is a better fit under installation guide. Additionally, we have an existing example there for setting up hive metastore for querying s3. So FileHiveMetastore can be another example to have at the same place.
I am open to hear your thoughts if you feel otherwise.

@rschlussel
Copy link
Contributor

Got it. I'm not sure putting it in deployment is more intuitive than having it in connectors, but this is fine. I do think wherever they live, we should link to these docs from all the lakehouse connectors.

@steveburnett steveburnett deleted the steveburnett-filebased-metastore2 branch February 27, 2025 16:28
@steveburnett
Copy link
Contributor Author

Got it. I'm not sure putting it in deployment is more intuitive than having it in connectors, but this is fine. I do think wherever they live, we should link to these docs from all the lakehouse connectors.

Great idea! I opened #24623 to not forget this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs from:IBM PR from IBM
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

8 participants