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.

Sign up for GitHub

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

Jump to bottom

Add documentation for Druids catalog extension #17459

Merged
merged 15 commits into from
Nov 12, 2024
Merged

Add documentation for Druids catalog extension #17459

merged 15 commits into from
Nov 12, 2024

Conversation

zachjsh
Copy link
Contributor

@zachjsh zachjsh commented Nov 7, 2024

This pr adds docs for Druids catalog extension

This PR has:

  • been self-reviewed.
  • added documentation for new or modified features or behaviors.
  • a release note entry in the PR description.
  • added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
  • added or updated version, license, or notice information in licenses.yaml
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met.
  • added integration tests.
  • been tested in a test Druid cluster.

amaechler
amaechler reviewed Nov 8, 2024
View reviewed changes
Copy link
Contributor

@amaechler amaechler left a comment

Choose a reason for hiding this comment

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

Only nits, thanks for adding!

docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
docs/development/extensions-core/catalog.md Outdated Show resolved Hide resolved
@zachjsh zachjsh requested a review from amaechler November 8, 2024 18:18
@zachjsh
Copy link
Contributor Author

zachjsh commented Nov 8, 2024

Only nits, thanks for adding!

Thanks for reviewing @amaechler ! Think I addressed all of your comments. Good suggestions.

@zachjsh zachjsh merged commit 1f3b1f8 into apache:master Nov 12, 2024
12 checks passed
@zachjsh zachjsh deleted the catalog-docs branch November 12, 2024 19:51
jtuglu-netflix pushed a commit to jtuglu-netflix/druid that referenced this pull request Nov 20, 2024
@zachjsh @amaechler @jtuglu-netflix
Add documentation for Druids catalog extension (apache#17459)
91389c3 
* SQL syntax error should target USER persona

* * revert change to queryHandler and related tests, based on review comments

* * add test

* Add documentation for druid-catalog extension

* * fix error

* * fix error

* Apply suggestions from code review

Co-authored-by: Andreas Maechler <[email protected]>

* * fix spelling error

* * fix spelling

---------

Co-authored-by: Andreas Maechler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amaechler amaechler amaechler approved these changes

Assignees
No one assigned
Labels
Area - Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zachjsh @amaechler