Re: Request to contribute to Apache Pulsar JIRA maintenance and documentation
Hi Yuvaraj, Thanks for your willingness to contribute to Pulsar. To answer your question about the client docs in short - No, you don't need to replicate. They are not excluded but restructured in 3.0 according to PIP-228 [1]. This restructuring aims to improve the developer experience by helping them get started with bite-sized info [2] and build a solid model to make the doc set easier to scale. Feel free to continuously improve the docs! [1]: https://github.com/apache/pulsar/issues/18822https://github.com/apache/pulsar/issues/18822 [2]: https://pulsar.apache.org/docs/3.0.x/client-libraries-java/ Best, Jun From: Yuvaraj Madeshwaran Sent: Tuesday, July 11, 2023 3:34 To: Dave Fisher ; li...@apache.org Cc: dev@pulsar.apache.org Subject: Re: Request to contribute to Apache Pulsar JIRA maintenance and documentation Hi Liuyu & Dave, Thanks for sharing the information. I have gone through the documentation of Apache Pulsar and found that the Version 3.0.X documentation for Java client is not complete in the link, https://pulsar.apache.org/docs/3.0.x/client-libraries-java-use/ It's missing documentation for a couple of topics as below, 1. TableView 2. Schema 3. Authentication 4. Cluster Level failover Documentation for the same exists in version below in the link https://pulsar.apache.org/docs/2.11.x/client-libraries-java/ Can you please suggest to me, Do we need to replicate the documentation in Version 3 ? If yes, Shall I fork a new branch, make changes in it ? Thanks in advance! Regards, Yuvaraj Madheswaran
Re: Request to contribute to Apache Pulsar JIRA maintenance and documentation
Hi Liuyu & Dave, Thanks for sharing the information. I have gone through the documentation of Apache Pulsar and found that the Version 3.0.X documentation for Java client is not complete in the link, https://pulsar.apache.org/docs/3.0.x/client-libraries-java-use/ It's missing documentation for a couple of topics as below, 1. TableView 2. Schema 3. Authentication 4. Cluster Level failover Documentation for the same exists in version below in the link https://pulsar.apache.org/docs/2.11.x/client-libraries-java/ Can you please suggest to me, Do we need to replicate the documentation in Version 3 ? If yes, Shall I fork a new branch, make changes in it ? Thanks in advance! Regards, Yuvaraj Madheswaran On Thu, Jul 6, 2023 at 9:10 PM Dave Fisher wrote: > > Adding the OP who is not subscribed. > > Sent from my iPhone > > > On Jul 6, 2023, at 6:35 PM, Yu wrote: > > > > Hi Yuvaraj, > > > > Thank you for your willingness to contribute to the Pulsar documentation! > > > > Feel free to select your desired issues from > > https://github.com/apache/pulsar/issues?q=is%3Aopen+is%3Aissue+label%3Adoc-required > > . > > > > You can find the documentation contribution guide at > > https://pulsar.apache.org/contribute/document-intro/, and don't hesitate to > > reach out to me for any assistance or to have your pull requests reviewed. > > > > Yu > > > > > >> On Fri, Jul 7, 2023 at 8:50 AM Yuvaraj Madeshwaran > >> wrote: > >> > >> Dear Apache Pulsar Foundation, > >> > >> I am writing to express my interest in contributing to the JIRA dashboard > >> maintenance and documentation of Apache Pulsar Github repos. I have > >> developed a deep understanding of the software and JIRA. I am also > >> proficient in writing technical documentation. > >> > >> I believe that my skills and experience would be a valuable asset to the > >> Apache Pulsar project. I am a highly motivated and detail-oriented > >> individual, and I am always willing to go the extra mile. I am also a quick > >> learner, and I am always eager to learn new things. > >> > >> I am particularly interested in contributing to the following areas: > >> JIRA board maintenance > >> Documentation > >> Testing > >> > >> I am available to contribute on a part-time basis. I have attached my > >> resume for your review. I have also included a link to my GitHub profile > >> https://github.com/yuvarajmms . > >> > >> Thank you for your time and consideration. I look forward to hearing from > >> you soon. > >> > >> Sincerely, > >> Yuvaraj Madheswaran > >> >
Re: Request to contribute to Apache Pulsar JIRA maintenance and documentation
Adding the OP who is not subscribed. Sent from my iPhone > On Jul 6, 2023, at 6:35 PM, Yu wrote: > > Hi Yuvaraj, > > Thank you for your willingness to contribute to the Pulsar documentation! > > Feel free to select your desired issues from > https://github.com/apache/pulsar/issues?q=is%3Aopen+is%3Aissue+label%3Adoc-required > . > > You can find the documentation contribution guide at > https://pulsar.apache.org/contribute/document-intro/, and don't hesitate to > reach out to me for any assistance or to have your pull requests reviewed. > > Yu > > >> On Fri, Jul 7, 2023 at 8:50 AM Yuvaraj Madeshwaran >> wrote: >> >> Dear Apache Pulsar Foundation, >> >> I am writing to express my interest in contributing to the JIRA dashboard >> maintenance and documentation of Apache Pulsar Github repos. I have >> developed a deep understanding of the software and JIRA. I am also >> proficient in writing technical documentation. >> >> I believe that my skills and experience would be a valuable asset to the >> Apache Pulsar project. I am a highly motivated and detail-oriented >> individual, and I am always willing to go the extra mile. I am also a quick >> learner, and I am always eager to learn new things. >> >> I am particularly interested in contributing to the following areas: >> JIRA board maintenance >> Documentation >> Testing >> >> I am available to contribute on a part-time basis. I have attached my >> resume for your review. I have also included a link to my GitHub profile >> https://github.com/yuvarajmms . >> >> Thank you for your time and consideration. I look forward to hearing from >> you soon. >> >> Sincerely, >> Yuvaraj Madheswaran >>
Re: Request to contribute to Apache Pulsar JIRA maintenance and documentation
Hi Yuvaraj, Thank you for your willingness to contribute to the Pulsar documentation! Feel free to select your desired issues from https://github.com/apache/pulsar/issues?q=is%3Aopen+is%3Aissue+label%3Adoc-required . You can find the documentation contribution guide at https://pulsar.apache.org/contribute/document-intro/, and don't hesitate to reach out to me for any assistance or to have your pull requests reviewed. Yu On Fri, Jul 7, 2023 at 8:50 AM Yuvaraj Madeshwaran wrote: > Dear Apache Pulsar Foundation, > > I am writing to express my interest in contributing to the JIRA dashboard > maintenance and documentation of Apache Pulsar Github repos. I have > developed a deep understanding of the software and JIRA. I am also > proficient in writing technical documentation. > > I believe that my skills and experience would be a valuable asset to the > Apache Pulsar project. I am a highly motivated and detail-oriented > individual, and I am always willing to go the extra mile. I am also a quick > learner, and I am always eager to learn new things. > > I am particularly interested in contributing to the following areas: > JIRA board maintenance > Documentation > Testing > > I am available to contribute on a part-time basis. I have attached my > resume for your review. I have also included a link to my GitHub profile > https://github.com/yuvarajmms . > > Thank you for your time and consideration. I look forward to hearing from > you soon. > > Sincerely, > Yuvaraj Madheswaran >
