JDocs Project by Shivam Rajput

我是 Shivam Rajput,目前在印度 Amity 大学攻读计算机科学与工程学士学位(Btech-CSE)。当我还是个孩子玩电子游戏时,我发现了“计算机的世界”。我对参加他们的实验室感兴趣,并决定在这个领域开始我的职业生涯。一旦我完成了我的学校生活,我决定在计算机领域进行 Btech 学习,我选择了 CSE 专业。

在 Amity 的第二年,我被介绍给了德里 Python 社区,‘PyDelhi。’我开始参与开源世界。这是提高我对开源知识了解的绝佳机会。
我参加了会议,组织了研讨会,并在大学里开始了我的俱乐部,主要是为了建立一个对这一主题感兴趣的小型学生社区。
当我开始接触 Web 开发内容时,我发现了不同类型的框架,其中之一是 Joomla,它因其灵活性更吸引我。

这个 Joomla! Google 夏季代码(GSoC)项目是我第一次在高级别上参与开源项目。我已经从我的导师和 Joomla! 社区成员那里学到了很多。
当 GSOC 2017 组织名单公布时,我迅速搜索了 Joomla。我很兴奋地为 Joomla! 项目申请。
我按照 Puneet Kala 的建议开始测试补丁,以了解代码。
我选择了我认为我的才能可能有用的地方,并提交了我的提案。我很高兴我的提案被接受了!我为成为 Joomla! 家庭的一部分感到非常自豪!

什么是 GSOC?

GSOC 是一个由 Google 赞助的夏季编程项目。来自世界各地不同大学的各种学生参与这个项目。他们被分配到不同开源组织的一个项目。在项目成功完成后,Google 会向学生颁发津贴。

Joomla! 4 导航指南

我的项目主要目标是让 Joomla! 4 对新用户更加友好。
我将通过提供一个更互动、用户友好的 Joomla! 网站管理(后端)导航指南来实现这一目标。

谁能从这次导航中受益?

想要轻松了解 Joomla 后端组件的新用户。

将采取什么方法?

也许...可以像后端组件的高级导航一样,不超过6个关键点来介绍如何使用该组件。

目前我们只有帮助屏幕来帮助新 Joomla! 用户了解任何组件视图的概览。为了帮助新用户更轻松、更互动地使用,这个项目已经提交。

以下是这个项目愿景的一个示例。

gsoc 2017 joomla documentation
gsoc 2017 joomla documentation

是的,当然这个功能可以由更有经验用户开启或关闭。

重构帮助屏幕

项目的第二部分是提供一个更易于管理、更省时的系统来更新帮助屏幕。
为了完成这个任务,我们将使用一个机器人来自动化 JDocs。

通过帮助维护帮助屏幕的志愿者,我们旨在使它们更易于管理和更新,以惠及所有用户。

目前我们有两个选择

  1. 手动执行
  2. 设置一个机器人,一键更改编辑。

你可以在我的项目页面 https://github.com/joomla-projects/gsoc17_helpscreens_on_jdocs  或团队页面 https://volunteers.joomla.org/teams/gsoc-17-refactoring-help-screen-on-jdocs  查看更多信息。

我的进展如何?

我已在后端组件视图中实现了一个导航按钮,点击一下即可触发导航。
使用 Hopscotch 和 BootStrap Tour JS 库,我已经开始实现导航,并实现了用于导航步骤的 JSON 文件动态链接创建。
我们就导航和机器人进行了多次会议讨论。

以下是我们讨论的一些链接

需要与团队讨论后为不同视图准备导航。

开始进行机器人工作

(我将在我的第二篇文章中发布关于它的更新。所以请保持关注!)

项目目标

  • 导航将帮助新用户快速了解管理组件,并在使用 Joomla! 的同时提高用户友好性。
  • 项目的第二部分是帮助我们的志愿者,减轻他们创建和更新帮助屏幕的任务。通过更轻松、更快捷的方法来更新和翻译,可以帮助新用户提供正确的信息。


我非常感谢我的导师 Tom Hutchison、Peter Martin、Sandra Thevenet 和 João Reys Santos 的指导,帮助我撰写了我的第一篇博客文章,以及他们提供的宝贵反馈和定期审查项目。
我还想感谢 GSoC-Joomla! 团队管理员 Puneet Kala 和 Yves Hoppe 的指导。