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

Revamp design page #15486

Merged
merged 6 commits into from
Dec 8, 2023
Merged

Conversation

ektravel
Copy link
Contributor

@ektravel ektravel commented Dec 4, 2023

Description

This PR revamps the Design section of the documentation as follows:

  • Adds a new subsection called Services to the sidebar
  • Adds an updated Druid architecture diagram
  • Moves "Storage design" section out of design.md and into its own topic
  • Moves "Query processing" section out of design.md and into its own topic
  • Consolidates the information in "Design" and "Processes and servers" topics
  • Removes "Processes and servers" topic from the sidebar
  • Replaces "process" with "service"
  • Adds a redirect for processes.md

Preview

https://druid-98c2egkpg-katyamacedo-bigcommerce.vercel.app/docs/latest/design/architecture

This PR has:

  • been self-reviewed.

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

I think this is mostly OK. However, I think it would be worth it to get clarity on the router, which seems really out of date.

docs/design/architecture.md Outdated Show resolved Hide resolved
docs/design/architecture.md Show resolved Hide resolved
docs/design/broker.md Outdated Show resolved Hide resolved
docs/design/broker.md Outdated Show resolved Hide resolved
@ektravel ektravel requested a review from techdocsmith December 6, 2023 17:14
Copy link
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 spelling fixes:

    ../docs/design/architecture.md
      115 | Colocating Druid services by server type 

    ../docs/design/coordinator.md
       79 | of segments across Historical servicees in the cluster, the Coordinat 

    ../docs/design/router.md
       26 | roker routes queries based on preconfigured [data retention rules](../ope 

docs/design/storage.md Outdated Show resolved Hide resolved
docs/design/storage.md Outdated Show resolved Hide resolved
website/redirects.js Show resolved Hide resolved
@techdocsmith techdocsmith merged commit 355c800 into apache:master Dec 8, 2023
11 checks passed
@techdocsmith techdocsmith deleted the sidebar-add-services branch December 8, 2023 19:40
@LakshSingla LakshSingla added this to the 29.0.0 milestone Jan 29, 2024
@a2l007
Copy link
Contributor

a2l007 commented Aug 27, 2024

Looks like the word Historicals is misspelt on the architecture diagram.
@ektravel If you have the source image handy, It would be great if you could fix this.

@ektravel
Copy link
Contributor Author

ektravel commented Sep 3, 2024

@a2l007 Thank you for bringing it to my attention. I will update the source image.

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