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

Automatic compaction API documentation refactor #14740

Merged
merged 11 commits into from
Aug 21, 2023
Merged

Automatic compaction API documentation refactor #14740

merged 11 commits into from
Aug 21, 2023

Conversation

demo-kratia
Copy link
Contributor

Refactor the Automatic compaction API documentation.

Preview: https://druid-git-automatic-compaction-doc-refactor-demo-kratia.vercel.app/docs/api-reference/automatic-compaction-api.html

This PR has:

  • been self-reviewed.

ektravel
ektravel reviewed Aug 7, 2023
View reviewed changes
Copy link
Contributor

@ektravel ektravel left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Left some suggestions. Let me know if something is not clear.

docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
ektravel
ektravel reviewed Aug 10, 2023
View reviewed changes
Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

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

A few nits.

@demo-kratia @ektravel
Apply suggestions from code review
cb0ff33 
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
ektravel
ektravel approved these changes Aug 10, 2023
View reviewed changes
Copy link
Contributor

@ektravel ektravel left a comment

Choose a reason for hiding this comment

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

The changes look good!

vtlim
vtlim reviewed Aug 11, 2023
View reviewed changes
Copy link
Member

@vtlim vtlim left a comment

Choose a reason for hiding this comment

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

Overall nice improvements. Left some minor comments and a few things to suss out (different values for max tasks listed, and suggested content rearrangement)

docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
docs/api-reference/automatic-compaction-api.md Outdated Show resolved Hide resolved
vtlim
vtlim approved these changes Aug 14, 2023
View reviewed changes
Copy link
Member

@vtlim vtlim left a comment

Choose a reason for hiding this comment

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

LGTM 🦖

cc @suneet-s @maytasm in case you have comments

@vtlim vtlim merged commit 9fe7c01 into apache:master Aug 21, 2023
10 checks passed
@vtlim vtlim deleted the automatic-compaction-doc-refactor branch August 21, 2023 18:34
@LakshSingla LakshSingla added this to the 28.0 milestone Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vtlim vtlim vtlim approved these changes

@ektravel ektravel ektravel approved these changes

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

Successfully merging this pull request may close these issues.
5 participants
@demo-kratia @vtlim @ektravel @LakshSingla @317brian