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

[Docs] Refactor streaming ingestion section #15591

Merged
merged 16 commits into from
Feb 12, 2024
Merged

[Docs] Refactor streaming ingestion section #15591

merged 16 commits into from
Feb 12, 2024

Conversation

ektravel
Copy link
Contributor

@ektravel ektravel commented Dec 18, 2023 •
edited

Refactor Druid streaming ingestion section

This PR:

  • Adds new topics: streaming.md and supervisor.md
  • Adds two endpoints to the Streaming API reference
  • Removes two topics: kafka-supervisor-operations.md and kafka-supervisor-reference.md. The information in these topics was incorporated into kinesis-ingestion.md and supervisor-api.md.
  • Updates kinesis-ingestion.md and kinesis-ingestion.md. The updates include text edits, styling edits, and moving information to other topics such as streaming.md, supervisor.md, and supervisor-api.md.
  • Adds redirects for the topics that were removed
  • Adds new topics to sidebars.json

Preview

https://druid-git-streaming-ingestion-revamp-katyamacedo-bigcommerce.vercel.app/docs/latest/ingestion/streaming

This PR has:

  • been self-reviewed.

techdocsmith
techdocsmith requested changes Jan 9, 2024
View reviewed changes
docs/api-reference/supervisor-api.md Outdated Show resolved Hide resolved
docs/api-reference/supervisor-api.md Outdated Show resolved Hide resolved
docs/api-reference/supervisor-api.md Outdated Show resolved Hide resolved
docs/api-reference/supervisor-api.md Show resolved Hide resolved
docs/api-reference/supervisor-api.md Outdated Show resolved Hide resolved
docs/development/extensions-core/kafka-ingestion.md Outdated Show resolved Hide resolved
docs/development/extensions-core/kafka-ingestion.md Outdated Show resolved Hide resolved
docs/development/extensions-core/kafka-ingestion.md Outdated Show resolved Hide resolved
docs/development/extensions-core/kafka-ingestion.md Outdated Show resolved Hide resolved
docs/development/extensions-core/kinesis-ingestion.md Outdated Show resolved Hide resolved
@techdocsmith
Copy link
Contributor

Awesome refactor @ektravel , requested some changes (some probably outside the original scope)

@vogievetsky vogievetsky added the Needs web console change Backend API changes that would benefit from frontend support in the web console label Jan 19, 2024
@vogievetsky
Copy link
Contributor

adding a needs web console change tag to remind us to go through and make sure that all the property descriptions in the console agree with that this PR ends up merging and that any web console doc links are updated.

techdocsmith
techdocsmith reviewed Feb 6, 2024
View reviewed changes
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.

This is looking good. I haven't tested any of the examples yet.

@techdocsmith techdocsmith self-requested a review February 6, 2024 00:53
techdocsmith
techdocsmith requested changes Feb 7, 2024
View reviewed changes
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.

Let's get a consensus on the example syntax. Afterward, LGTM

docs/api-reference/supervisor-api.md Show resolved Hide resolved
docs/api-reference/supervisor-api.md Show resolved Hide resolved
@ektravel
Copy link
Contributor Author

ektravel commented Feb 9, 2024 •
edited

@techdocsmith I reverted back to using a colon with placeholders in API calls because Docusaurus doesn't treat the <code> tag the same as backticks. Docusaurus/React tries to interpolate {example} as a variable.

techdocsmith
techdocsmith approved these changes Feb 12, 2024
View reviewed changes
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

@techdocsmith techdocsmith merged commit 0f29ece into apache:master Feb 12, 2024
11 checks passed
@techdocsmith techdocsmith deleted the streaming-ingestion-revamp branch February 12, 2024 21:52
ektravel added a commit to ektravel/druid that referenced this pull request Feb 13, 2024
@ektravel
[Docs] Refactor streaming ingestion section (apache#15591)
fde8dfa 
Merging the work so far. @ektravel , @vogievetsky if there are additional improvements, let's track them & make another pr.

* Refactor streaming ingestion docs

* Update property definition

* Update after review

* Update known issues

* Move kinesis and kafka topics to ingestion, add redirects

* Saving changes

* Saving

* Add input format text

* Update after review

* Minor text edit

* Update example syntax

* Revert back to colon

* Fix merge conflicts

* Fix broken links

* Fix spelling error
317brian pushed a commit that referenced this pull request Feb 13, 2024
@ektravel
[Backport] Refactor streaming ingestion section (#15591) (#15901)
ffe8e12
sreemanamala pushed a commit to sreemanamala/druid that referenced this pull request Feb 20, 2024
@ektravel @sreemanamala
[Docs] Refactor streaming ingestion section (apache#15591)
2d14373 
Merging the work so far. @ektravel , @vogievetsky if there are additional improvements, let's track them & make another pr.



* Refactor streaming ingestion docs

* Update property definition

* Update after review

* Update known issues

* Move kinesis and kafka topics to ingestion, add redirects

* Saving changes

* Saving

* Add input format text

* Update after review

* Minor text edit

* Update example syntax

* Revert back to colon

* Fix merge conflicts

* Fix broken links

* Fix spelling error
@adarshsanjeev adarshsanjeev added this to the 30.0.0 milestone May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@techdocsmith techdocsmith techdocsmith approved these changes

@vogievetsky vogievetsky Awaiting requested review from vogievetsky

@317brian 317brian Awaiting requested review from 317brian

Assignees
No one assigned
Labels
Area - Documentation Needs web console change Backend API changes that would benefit from frontend support in the web console
Projects
None yet
Milestone
30.0.0
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@ektravel @techdocsmith @vogievetsky @adarshsanjeev