Skip to content

Service status API documentation refactor#14528

Merged
techdocsmith merged 18 commits intoapache:masterfrom
demo-kratia:service-status-api-refactor
Jul 26, 2023
Merged

Service status API documentation refactor#14528
techdocsmith merged 18 commits intoapache:masterfrom
demo-kratia:service-status-api-refactor

Conversation

@demo-kratia
Copy link
Copy Markdown
Contributor

@demo-kratia demo-kratia commented Jul 5, 2023

Refactor the Service status API documentation to make easier to browse.

Preview: https://druid-git-service-status-api-refactor-demo-kratia.vercel.app/docs/api-reference/service-status-api.html

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
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.

Awesome start! Requested some changes/clarifications

Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
@demo-kratia demo-kratia requested a review from techdocsmith July 11, 2023 23:04
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 after nits

Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Copy link
Copy Markdown
Member

@asdf2014 asdf2014 left a comment

Choose a reason for hiding this comment

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

It would be better to format markdown table, others look good to me 🚀

Comment thread docs/api-reference/service-status-api.md
Comment thread docs/api-reference/service-status-api.md
@demo-kratia demo-kratia force-pushed the service-status-api-refactor branch from 3afa7be to 1a50b91 Compare July 21, 2023 16:07
Comment thread docs/api-reference/service-status-api.md Outdated
Copy link
Copy Markdown
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.

Minor edit to align lines 37 and 38.

Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
@ektravel
Copy link
Copy Markdown
Contributor

@asdf2014 Using a markdown table formatter does not always produce the expected result. To ensure that markdown tables render correctly, we remove any extra space between the columns.

Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
Comment thread docs/api-reference/service-status-api.md Outdated
refine instruction regarding default host/port
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

@techdocsmith techdocsmith merged commit 2dc3e94 into apache:master Jul 26, 2023
demo-kratia added a commit to demo-kratia/druid that referenced this pull request Jul 27, 2023
Co-authored-by: Katya Macedo  <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
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.

5 participants