Skip to content

Clean up Kinesis doc - #14529

Merged
techdocsmith merged 13 commits into
apache:masterfrom
ektravel:kinesis-cleanup
Jul 26, 2023
Merged

Clean up Kinesis doc#14529
techdocsmith merged 13 commits into
apache:masterfrom
ektravel:kinesis-cleanup

Conversation

@ektravel

@ektravel ektravel commented Jul 5, 2023

Copy link
Copy Markdown
Contributor

Description

This PR:

  • Adds "Default" column to tables
  • Removes most of future tense
  • Collapses examples using <details><summary></summary></details>
  • Changes heading from title case to sentence case
  • Adds code font where applicable
  • Removes the link to PR 5102 which has already been merged
  • Consolidates information
  • Removed redundant information
  • places intermediateHandoffPeriod after maxTotalRows
  • documents skipBytesInMemoryOverheadCheck

This PR does not address the usage of passive voice. That can be done as a separate PR.

This PR has:

  • been self-reviewed.

@writer-jill writer-jill left a comment

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.

Several small suggestions! Looks good

Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated

@writer-jill writer-jill left a comment

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.

Several small suggestions! Looks good

@writer-jill writer-jill left a comment

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.

LGTM

@techdocsmith techdocsmith left a comment

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.

Some initial comments

Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
@ektravel
ektravel requested a review from writer-jill July 21, 2023 21:23
@ektravel
ektravel requested a review from techdocsmith July 24, 2023 20:39

@writer-jill writer-jill left a comment

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.

Just a couple of suggestions - looks good!

Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated
Comment thread docs/development/extensions-core/kinesis-ingestion.md Outdated

@techdocsmith techdocsmith left a comment

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.

See comments for requested changes.

@techdocsmith techdocsmith left a comment

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.

LGTM

@techdocsmith
techdocsmith merged commit 4804630 into apache:master Jul 26, 2023
@ektravel
ektravel deleted the kinesis-cleanup branch July 27, 2023 16:48
demo-kratia added a commit to 317brian/druid that referenced this pull request Jul 28, 2023
vtlim pushed a commit that referenced this pull request Jul 28, 2023
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
@vtlim vtlim added this to the 27.0 milestone Jul 31, 2023
AmatyaAvadhanula pushed a commit that referenced this pull request Aug 4, 2023
* delete old website directory

* upgrade 27.0.0 branch

* convert code tabs

* delete script

* update redirects

* add .spelling file

* fix tasks-api page syntax

* fix spelling file

* fix spelling errors

* delete hidden section

* add service status update into doc2 update

* add service-status

* fix license tab

* fix spelling conflict for supervisor cherrypick

* code tabs for supervisor-api

* fix kinesis link in supervisor-api, bc #14529 heading change

* undo link fix with kinesis doc backported

* JSON-querying API documentation refactor (#14589)

Co-authored-by: Jill Osborne <jill.osborne@imply.io>
Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
(cherry picked from commit 53733d2)

* code tabs for json querying

* remove <br> tags

* minor format fix

* docs: update admonitions to the Docusaurus 2 style (#20)

---------

Co-authored-by: Nhi Pham <56242907+demo-kratia@users.noreply.github.com>
Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
riovic918data pushed a commit to riovic918data/druid that referenced this pull request Jun 12, 2026
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.

4 participants