[Doc] Add user guide for Pulsar connector

[Anonymitaet]

Hi Trino community,

Pulsar community is contributing the Pulsar connector to Trino with code and docs:

• Code PR: [Connector]Add plugin for Apache Pulsar. #8020

• Doc PR: we wrote and discussed the contents in google doc before.
  After finalizing the contents, I send this PR.
  I preview the contents in my local machine, everything goes fine.

Pulsar connector guide

Pulsar connector tutorial guide

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Anonymitaet.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[Anonymitaet]

@mosabua could you please help review? Many thanks

[Anonymitaet]

Hi @mosabua, could you please help answer my questions? Many thanks!

Q1. This the 1st time I contribute content to Trino.
I've sent my signed CLA to cla@trino.io, anything else I need to do?

Q2. do my settings affect me submitting this PR?

[mosabua]

@Anonymitaet you need to check what email you are using in your local git config and that email needs to be registered with github. Your screenshots look correct.

You just have to submit a signed CLA and then @martint or another maintainer will file it and update https://github.com/trinodb/cla/blob/master/contributors .. then the CLA check on this PR can pass.

[mosabua]

I will review tomorrow, but just fyi @electrum this PR is based on a google doc we collaborated on with @Anonymitaet and @MarvinCai so it should be pretty good already.

[mosabua]

Please format all paragraphs to 80 column width in the source @Anonymitaet

[kokosing]

Please keep in mind that we cannot merge documentation without merging first code. Surely, code can change during the code review process.

[mosabua]

@kokosing we are aware. The plan is to get the code and the doc PR to good enough quality on both sides in parallel and then merge both together so they end up shipping in the same release.

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Anonymitaet.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Anonymitaet.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[Anonymitaet]

@mosabua thanks for your explanations! I've rewrapped the texts, could you please help review?

[mosabua]

you need to indent this so that "Network" and "service" line up.. same applies to all other list items..

[Anonymitaet]

@mosabua thanks for your instruction! I've indented and successfully previewed the contents:

Any other comments on this doc PR?

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Anonymitaet.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[Anonymitaet]

@Anonymitaet you need to check what email you are using in your local git config and that email needs to be registered with github. Your screenshots look correct.

You just have to submit a signed CLA and then @martint or another maintainer will file it and update https://github.com/trinodb/cla/blob/master/contributors .. then the CLA check on this PR can pass.

Hi @martint, I see my name in https://github.com/trinodb/cla/blob/master/contributors but seems that CLA checks fail. Could you please give some instructions on this? Thanks

[findepi]

@cla-bot check

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Anonymitaet.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

The cla-bot has been summoned, and re-checked this pull request!

[findepi]

Hi @martint, I see my name in https://github.com/trinodb/cla/blob/master/contributors but seems that CLA checks fail. Could you please give some instructions on this? Thanks

@Anonymitaet the commits are not associated with your github id.
See for example https://github.com/trinodb/trino/pull/8469/commits - "Anonymitaet" should be a link to your profile (like on https://github.com/trinodb/trino/pull/8935/commits)
it's not, because the email you use in git (git config --global) is not associated with your github profile.
Actually, it's not a valid email address at all.

if you don't want to use your actual email address in the commits, see https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-on-github for github-provided noreply-type email address.

[Anonymitaet]

Hi @findepi many thanks for your guidance!

Below are my settings:

Double-check if my understanding is correct, do you mean changing my primary email to anonymitaet_@hotmail.com (it is used to register my GitHub account)?

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Anonymitaet.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email email@example.com
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[Anonymitaet]

Hi @findepi

I've fixed the issue

and pushed a commit. But the CLA bot appeared again and the CLA tests still fail.

What should I do? Many thanks for your help!

[Anonymitaet]

I've re-submitted a PR #8977 and the CLA test pass, so I will close this PR.
Many thanks for your guidance! @MarvinCai

[findepi]

I've re-submitted a PR #8977 and the CLA test pass, so I will close this PR.

awesome that you figured this out!