Hi Dianjin, Thank you for sharing the exciting news about Apache Pulsar's participation in OSPP 2023.
## Project Info Project Name: BookKeeper journal supports Direct IO Project Description: Apache BookKeeper is the storage layer of Apache Pulsar, and it plays a key role in Apache Pulsar's performance. The Pulsar broker writes data to the BookKeeper cluster and waits for the write response. The BookKeeper's bookie node receives the write requests and persists the data into the storage layer. BookKeeper's storage layer has two types of storage. One is Journal, and the other is Ledger. Journal is a WAL log of the bookie. Once the write request data is persisted into the Journal disk, the bookie will send the write response to the Pulsar broker. The ledger supports the data storage layer of the bookie and provides data read and write. Ledger already supports the Direct IO to improve the read and write throughput, but Journal still relies on the OS PageCache. We need to make Journal also support Direct IO to improve the BookKeeper's write performance. Difficulty Level: - [ ] Basic - [x] Advanced Project Output Requirements: Item 1: Write a proposal for the journal Direct IO support Item 2: Journal support Direct IO Item 3: Add unit tests for the Direct IO support Item 4: Add performance test result Project Technical Requirements: Item 1: Get the knowledge of Apache BookKeeper to write logic Item 2: Get knowledge of Linux Direct IO Item 3: Get knowledge of how the current ledger uses Direct IO ## Mentor Info Mentor Name: chenhang Mentor Email: chenh...@apache.org Thanks, Hang Yu <li...@apache.org> 于2023年4月25日周二 23:44写道： > > Hi Dianjin, > > Thanks for your reminder! > > Please check my application here ( > https://docs.google.com/document/d/1fSVi1ELO7hGSF6_Cm1O9A-kw7covij882_cajLg4Jzs/edit#), > which is more user-friendly to read and re-use info. > > Also, attach here for your quick reference. > > ========English Version======== > > # Project Info > > ## Project Name > > Optimizing the findability of Pulsar documentation with SEO strategies > > ## Project Description > > Recently, the Apache Pulsar community has witnessed robust and energetic > growth with faster release iterations and comprehensive documentation, > providing delightful experiences for Pulsar users. As more and more users > search Pulsar-relevant content on Google, the findability of Pulsar > documentation is increasingly important since higher organic search > rankings can build brand awareness and enhance competitiveness. So this > project aims to improve the findability and searchability of content on the > Pulsar documentation website by applying effective SEO strategies. It > includes but is not limited to the following aspects: > > - Provide recommendations and make changes accordingly: perform an audit > (criteria + verifications) of the Pulsar documentation and provide > recommendations (issues + priorities) for improvement that support the > Pulsar user journey. > > - Earn featured snippets to set Pulsar documentation “position zero” on > Google search results. > > - Add description metadata to increase click-through rates to Pulsar > documentation by showing appealing excerpts. > > - Add alt tags for images to enable search engines to crawl visuals and > empower screen readers to process images. > > ### References > > - Pulsar documentation website: https://pulsar.apache.org/docs/next/ > > - Task info | Optimizing Pulsar SEO: > https://docs.google.com/document/d/1xGvp7msOYGjh-YDI1JtJ_ORWACEPWnBlhMMkZbylefQ/edit#heading=h.188884qgj6cz > > ## Difficulty Level > > [ ] Basic > > [x] Advanced > > ## Project Validation Requirements > > - For the project > > 1) Submit a report of improvement suggestions for Pulsar documentation and > corresponding documentation changes. > > 2) Improve SEO for the Pulsar documentation website by earning “feature > snippets”, adding “description metadata”, and inserting “alt tags”. > > 3) Submit a performance comparison report of SEO results for Pulsar > documentation. > > 4) Document best practices for Pulsar SEO implementation. > > - For the student > > Acquire new skills and gain useful experience to level up your portfolio. > For example, > > Learn the ins and outs of open source by being mentored by experienced > community members. > > Strengthen your abilities of communication and collaboration by balancing > requirements and resolving issues. > > Build your network by deeply working with industry veterans. > > ## Project Technical Requirements > > - Strong communication, problem-solving, and holistic thinking abilities. > > - Excellent skills in English and technical writing. > > - Familiarity with Docs as Code (e.g., Git, Markdown, Docusaurus, Swagger). > > - Previous experience in open-source projects. > > - Proficiency in any programming language or major in computer science is > preferred. > > ## Project Repo > > - Pulsar documentation and website repo: > https://github.com/apache/pulsar-site > > - Pulsar code repo: https://github.com/apache/pulsar > > # Mentor Info > > ## Mentor Name > > Yu Liu > > ## Mentor Email > > li...@apache.org > > y...@streamnative.io > > Do not hesitate to reach out to me if you have any questions or suggestions > on this project. Thank you! > > ====Chinese Version==== > > # 项目信息 > > ## 项目名称 > > 优化 SEO 策略 | 提升 Pulsar 文档的搜索可见性 > > ## 项目介绍 > > 最近几年，Apache Pulsar 社区发展迅猛，版本迭代速度快且文档内容丰富，给用户带来了不少惊喜体验。如今，越来越多的用户在网上搜索 > Pulsar 内容，官方文档的搜索可见性也愈发重要（更高的自然搜索排名能提升项目的知名度和竞争力）。因此，本项目旨在通过优化 SEO 策略，增强 > Pulsar 文档的搜索可见性，包括但不限于以下任务： > > - 提高文档质量：从 Pulsar 用户旅程视角出发，全盘审阅 Pulsar 文档，找出问题、提出建议并提交相应更改。 > > - 实现 featured snippets：优化文档内容，使 Pulsar 文档作为 featured snippets，显示为 Google > 搜索的第一结果，提高文档点击率。 > > - 增加元数据：为文档增加描述性元数据（descrption），优化 Google 搜索结果中的摘要，提升搜索结果的质量和相关性。 > > - 增加 alt 标签：为图片增加 alt 标签，增强内容的可读性。 > > ### 参考信息 > > - Pulsar 文档官网：https://pulsar.apache.org/docs/next/ > > - 优化 Pulsar SEO | 待完成任务 + 背景信息： > https://docs.google.com/document/d/1xGvp7msOYGjh-YDI1JtJ_ORWACEPWnBlhMMkZbylefQ/edit# > > ## 难度 > > [ ] 基础 > > [x] 高级 > > ## 项目产出要求 > > - 对于项目而言： > > 1）提交关于「如何改进 Pulsar 文档」的报告和相应的文档更改。 > > 2）实现 featured snippets、增加描述性元数据、增加 alt 标签。 > > 3）提交关于「Pulsar 文档 SEO 结果优化前后」的性能对比报告。 > > 4）提交关于「如何提升 Pulsar 文档 SEO 结果」的最佳实践。 > > - 对于学生而言： > > 希望你能打开视野，收获有利于今后人生发展的软硬技能。例如，了解开源社区的运作方式和最佳实践、增进沟通协调和平衡多方需求能力、拓展职场社交人脉等。最重要的是，找到你喜欢并擅长的事，持续深耕。 > > ## 项目技术要求 > > 希望你具备以下能力： > > - 优秀的沟通力、问题解决力和全局思维。 > > - 优秀的英语技术写作能力。 > > - 熟悉 Docs as Code（例如，Git, Markdown, Docusaurus, Swagger)。 > > - 具备开源社区经验。 > > - 技术背景是加分项。 > > ## 项目仓库 > > - Pulsar 文档和网站仓库：https://github.com/apache/pulsar-site > > - Pulsar 代码仓库：https://github.com/apache/pulsar > > # 导师信息 > > ## 导师名字 > > Yu Liu > > ## 导师邮箱 > > li...@apache.org > > y...@streamnative.io > > 如果你有任何问题或建议，欢迎随时联系我，谢谢！ > > On Sun, Apr 23, 2023 at 9:41 PM Dianjin Wang <wangdian...@gmail.com> wrote: > > > Hi, > > > > If you're inserted in being the mentor, please send your project info by > > 04/25. We need to submit all the projects on 04/26 for approval. Thanks! > > > > Best, > > Dianjin Wang > > > > > > On Tue, Apr 11, 2023 at 10:52 AM Dianjin Wang <wangdian...@gmail.com> > > wrote: > > > > > Hi all, > > > > > > Glad to share that Apache Pulsar is listed at the OSPP 2023 again. This > > > year, the Pulsar community can open 7 projects at most. > > > > > > For OSPP 2023, the project idea will be open from 4/04, 2023 to 04/28, > > > 2023(UTC+8). If you have great ideas, please reply to this email by > > > following the project template. Then I can help you to submit them. > > > > > > OSPP asks that Pulsar committers, PMC members, and contributors be the > > > mentors; a mentor can only mentor one project. Both mentors and students > > > will receive financial awards for completed projects. > > > > > > You may want to know about OSPP 2022, so refer to this email[1] for > > > details. > > > > > > ------ > > > [Template] > > > > > > ## Project Info > > > Project Name: > > > Project Description: (at most 1000 words) > > > Difficulty Level: > > > - [ ] Basic > > > - [ ] Advanced > > > > > > Project Output Requirements: > > > Item 1:__________________________ > > > Item 2:__________________________ > > > Item 3:__________________________ > > > … > > > > > > Project Technical Requirements: > > > Item 1:__________________________ > > > Item 2:__________________________ > > > Item 3:__________________________ > > > … > > > > > > ## Mentor Info > > > Mentor Name: > > > Mentor Email: > > > ------ > > > > > > [1] https://lists.apache.org/thread/7pplcd4c35qjzt2o58qxykkty8qqxvt3 > > > > > > Best, > > > Dianjin Wang > > > > >
