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][Website] add docs of broker entry metadata #12404

Merged
merged 10 commits into from
Oct 19, 2021
Merged

[docs][Website] add docs of broker entry metadata #12404

merged 10 commits into from
Oct 19, 2021

Conversation

LeBW
Copy link
Contributor

@LeBW LeBW commented Oct 18, 2021 •
edited
Loading

add docs of broker entry metadata

Motivation

Currently, there is no docs about broker entry metadata. So we need to add it.

Modifications

add docs of broker entry metadata

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API: (no)
  • The schema: (no)
  • The default values of configurations: ( no)
  • The wire protocol: ( no)
  • The rest endpoints: (no)
  • The admin cli options: (no)
  • Anything that affects deployment: (no)

Documentation

Check the box below and label this PR (if you have committer privilege).

Need to update docs?

  • doc-required

    (If you need help on updating docs, create a doc issue)

  • no-need-doc

    (Please explain why)

  • doc

    (If this PR contains doc changes)

@eolivelli
Copy link
Contributor

@LeBW:Thanks for your contribution. For this PR, do we need to update docs?
(The PR template contains info about doc, which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)

@eolivelli eolivelli added doc-label-missing doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. labels Oct 18, 2021
@eolivelli
Copy link
Contributor

@LeBW:Thanks for providing doc info!

Anonymitaet
Anonymitaet reviewed Oct 19, 2021
View reviewed changes
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md
| payload | Required | Anything left in the frame is considered the payload and can include any sequence of bytes | |

## Broker entry metadata
Broker entry metadata is stored alongside the message metadata as a serialized protobuf message.
Copy link
Member

Choose a reason for hiding this comment

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

Please add an empty line before line 57

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
site2/docs/developing-binary-protocol.md Outdated Show resolved Hide resolved
LeBW and others added 9 commits October 19, 2021 10:56
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
70df1af 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
d4c9557 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
91ed135 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
722aa42 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
f4b5621 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
ea7df4b 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
5cadd08 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@LeBW
fix comments.
85eecd6
@LeBW @Anonymitaet
Update site2/docs/developing-binary-protocol.md
42bc755 
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@Anonymitaet Anonymitaet merged commit fd5bd6a into apache:master Oct 19, 2021
@LeBW LeBW deleted the add-brokerentrymetadata-doc branch October 19, 2021 15:26
zeo1995 pushed a commit to zeo1995/pulsar that referenced this pull request Oct 20, 2021
Merge branch 'up/master' into website/branch-2.7.2-chapter-3
88ac2a0 
* up/master:
  [pulsar-java-client] Auto-recovery after exception like out of direct memory (apache#12170)
  Allow to config pulsar client allocator out of memory policy (apache#12200)
  [Transaction] Fix bugs, Exception thrower by TB::appendBufferToTxn must be ManagedLedgerException.  (apache#12376)
  Bumped version to 2.10.0-SNAPSHOT (apache#12285)
  [docs][Website] add docs of broker entry metadata (apache#12404)
  [C++] Use weak ref to ClientConnection for timeout task (apache#12409)
  fix windows test path probleam (apache#12398)
  [website][upgrade]feat: home page (apache#12383)
  [docs] [ISSUE 11526] Update the description of `topic` (apache#12375)
  [Docs] Add document label check robot (apache#12371)
  [Admin] Get schema validation enforce add applied. (apache#12349)
  [Doc] add scope explanations (apache#12380)
  Fix java doc for MultipleListenerValidator (apache#12389)
zeo1995 pushed a commit to zeo1995/pulsar that referenced this pull request Oct 20, 2021
Merge branch 'website/branch-2.7.2-chapter-3' into website/branch-2.7…
987d7e8 
….2-chapter-4

* website/branch-2.7.2-chapter-3:
  Update the nesting of forms in the document
  [pulsar-java-client] Auto-recovery after exception like out of direct memory (apache#12170)
  Allow to config pulsar client allocator out of memory policy (apache#12200)
  [Transaction] Fix bugs, Exception thrower by TB::appendBufferToTxn must be ManagedLedgerException.  (apache#12376)
  Bumped version to 2.10.0-SNAPSHOT (apache#12285)
  [docs][Website] add docs of broker entry metadata (apache#12404)
  [C++] Use weak ref to ClientConnection for timeout task (apache#12409)
  fix windows test path probleam (apache#12398)
  [website][upgrade]feat: home page (apache#12383)
  [docs] [ISSUE 11526] Update the description of `topic` (apache#12375)
  [Docs] Add document label check robot (apache#12371)
  [Admin] Get schema validation enforce add applied. (apache#12349)
  [Doc] add scope explanations (apache#12380)
  Fix java doc for MultipleListenerValidator (apache#12389)
@Anonymitaet
Copy link
Member

This PR adds doc for #11553

dlg99 pushed a commit to dlg99/pulsar that referenced this pull request Jun 15, 2022
@LeBW @dlg99
[docs][Website] add docs of broker entry metadata (apache#12404)
79d9216 
* add docs of broker entry metadata

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* fix comments.

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
(cherry picked from commit fd5bd6a)
@dlg99 dlg99 mentioned this pull request Jun 15, 2022
Merged
eolivelli pushed a commit to datastax/pulsar that referenced this pull request Jun 16, 2022
@LeBW @eolivelli
[docs][Website] add docs of broker entry metadata (apache#12404)
091e9c8 
* add docs of broker entry metadata

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

* fix comments.

* Update site2/docs/developing-binary-protocol.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
(cherry picked from commit fd5bd6a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Anonymitaet Anonymitaet Anonymitaet approved these changes

Assignees

@LeBW LeBW

Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@LeBW @eolivelli @Anonymitaet