Skip to content

Tasks API documentation refactor#14492

Merged
vtlim merged 15 commits intoapache:masterfrom
demo-kratia:tasks-api-refactor
Jul 11, 2023
Merged

Tasks API documentation refactor#14492
vtlim merged 15 commits intoapache:masterfrom
demo-kratia:tasks-api-refactor

Conversation

@demo-kratia
Copy link
Copy Markdown
Contributor

@demo-kratia demo-kratia commented Jun 28, 2023

Refactor the Task API to make easier to browse.

Preview: https://druid-git-tasks-api-refactor-demo-kratia.vercel.app/

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.

Copy link
Copy Markdown
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.

Great work on this! Left comments on consistency and styling.

Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
@abhishekagarwal87 abhishekagarwal87 changed the title Tasks API refactor Tasks API documentation refactor Jun 29, 2023
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
Copy link
Copy Markdown
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 @techdocsmith to review also

Copy link
Copy Markdown
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

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

Great start. Added a few comments/ suggestions.

Comment thread docs/api-reference/tasks-api.md Outdated
@@ -25,77 +25,1565 @@ sidebar_label: Tasks

This document describes the API endpoints for task retrieval, submission, and deletion for Apache Druid.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Wonder if a brief definition of a task would be appropriate here. For example: https://druid.apache.org/docs/latest/ingestion/tasks.html
However, in addition to ingestion, I think tasks are going to start doing some of the querying from deep storage work. check with @317brian about those changes

Comment thread docs/api-reference/tasks-api.md
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
@techdocsmith techdocsmith mentioned this pull request Jul 7, 2023
1 task
@demo-kratia demo-kratia requested a review from techdocsmith July 11, 2023 17:24
Comment thread docs/api-reference/tasks-api.md Outdated
Comment thread docs/api-reference/tasks-api.md Outdated
minor style updates/clarifications
Copy link
Copy Markdown
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

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

LGTM

@vtlim vtlim merged commit d76903f into apache:master Jul 11, 2023
sergioferragut pushed a commit to sergioferragut/druid that referenced this pull request Jul 21, 2023
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
demo-kratia added a commit to demo-kratia/druid that referenced this pull request Jul 27, 2023
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
vtlim pushed a commit that referenced this pull request Jul 28, 2023
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
@vtlim vtlim added this to the 27.0 milestone Jul 31, 2023
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.

3 participants