值得一看的网站:开放式内容和设计来到 jQuery

发布日期 作者

在过去的几天和几周里,你可能已经注意到我们在我们的网站上推出的新主题。事实上,除非这是你第一次查看 jQuery 博客,否则这篇文章可能看起来与你过去几年一直看到的文章大不相同。今天,随着这种新设计终于到达 jquery.com,我们非常高兴地揭开帷幕,解释我们一直在做的工作以及它如何超越了乍一看可能只是简单的“改头换面”。

随着 jQuery 生态系统的不断发展,jQuery 团队越来越难以控制不断膨胀的文档、设计、CMS 安装和维基。那些想要报告和修复文档错误的社区成员无处可去采取行动,即使对于那些有权限的人来说,情况也并没有好多少。所有这些内容和设计都锁在生产环境中,隐藏在众多不同的用户帐户后面,而且没有地方跟踪错误,因此可见度很低,进度最多只是渐进的。我们知道我们必须做出改变。

在过去的一年里,我们投入了巨大的努力来整合和简化我们的网站基础设施,并将所有网站内容、文档和设计开源。我们之所以这样做,是因为它已经极大地改善了我们自己的协作和前进能力,并且我们希望它能够为所有想要参与 jQuery 但不确定自己是否能够做出贡献的人打开新的参与途径。

好了,别再客套了——让我们看看技术栈吧!

git + grunt + WordPress

我们已经将几乎所有的文档和网站内容迁移到 GitHub 上的静态内容库中,它们以 HTML、Markdown 或 XML 格式维护,具体取决于内容类型。现在,如果您发现了一个错别字或认为某些内容需要澄清,您可以提交一个问题,甚至发送一个包含修复的拉取请求。从 jQuery.ajax 的源文档jquery.com 的首页,以及 这个新页面包含完整内容库列表的原始 Markdown,都是开源的!

我们使用 WordPress 以及我们自定义的主题和多站点配置 jquery-wp-content 来让内容在我们网站上呈现。使用这个单一的 WordPress 实例,我们可以更轻松、更方便地保持所有不同网站的外观和感觉一致,并保留我们根据需要轻松添加动态功能(如网站搜索和用户帐户)的能力。jquery-wp-content 还包含一个自定义安装脚本,可以轻松地为本地开发搭建整个 jQuery 网站网络,为进行更少限制的修复和新功能实验打开大门。同样,所有这一切意味着,如果您在任何 jQuery 网站上发现错误,都可以找到地方报告它们,如果您愿意,还可以自己进行修复!

(我们收到了来自 WordPress 开发人员 Andrew NacinDaryl Koopersmith 的大量帮助,他们在创建和维护 jquery-wp-content 上付出了巨大的努力,我们在此感谢他们辛勤的工作!)

WordPress 和静态内容库之间的连接是一个 grunt 构建和部署流程,该流程会处理内容文件并将它们同步到 WordPress 安装中,使用 XML-RPC。这意味着我们从不使用 WordPress 管理页面;所有创作和编辑都在你最喜欢的文本编辑器中进行,然后 grunt 完成繁重的工作。

为了部署到我们的生产和暂存服务器,我们只需要使用 git webhooks 来响应内容库和 jquery-wp-content 上的提交。每当提交到这些库的主分支时,内容和设计就会立即反映在暂存环境中,该环境只是网站 URL 带有 stage. 子域名前缀,例如 stage.jquery.com。要部署到生产网站,只需要 标记 一个 semver 并推送标记。

新网站

除了今天博客和 jquery.com 的新外观外,我们还很高兴地推出一些全新的网站,这些网站都由该系统驱动,如果你正在寻找参与 jQuery 的方法,你会发现这些网站特别有用。

贡献 jQuery

URL: contribute.jquery.org | Repo: github.com/jquery/contribute.jquery.org
我们新的中心,提供关于如何真正开始为 jQuery 和开源项目做出贡献的信息。它还为贡献者提供了许多有用的资源,例如我们的 CLA 表格 和我们所有项目都使用的 样式指南

jQuery IRC 中心

URL: irc.jquery.org | Repo: github.com/jquery/irc.jquery.org
jQuery 基金会广泛使用互联网中继聊天来提供支持和项目交流。在这里,我们托管频道日志,并保存有关如何连接以及到达那里后会遇到什么情况的文档。

jQuery 品牌指南

URL: brand.jquery.org | Repo: github.com/jquery/brand.jquery.org
由于我们最近更新了许多用于代表 jQuery 的约定,因此我们也发布了这些指南,以便社区能够更好地理解他们如何(以及不能)使用 jQuery 基金会项目的名称和标记。

日出,日落

我们也将在未来几周内告别一些子域名,我们希望提前通知您,以便您做好准备。

docs.jquery.com

我们最初的 MediaWiki 文档和全能网站多年来一直服务得很好,但现在是让它退休的时候了。我们将继续将该网站上的热门 URL 重定向到它们更现代的对应网站。

meetups.jquery.com

托管我们自己的聚会网络是一个有趣的尝试,但该网站几乎没有使用,而且我们管理起来很麻烦,所以我们将关闭它。我们建议组织者使用其他更成熟的平台,例如 meetup.com


除了我们刚刚推出的新网站外,我们还将在未来几天和几周内继续推出其他新网站,并将更多现有网站与新主题集成在一起。我们对目前取得的进展感到非常满意,并期待继续改进这些网站——也许有你的帮助!与往常一样,如果您遇到任何问题,请提交问题,加入我们 #jquery-content 频道freenode 上,或者发送电子邮件至 content at jquery dot com

关于 “值得一看的网站:开放式内容和设计来到 jQuery” 的 9 个想法

  1. 当你看到应用于 API 文档的新设计时,你应该看看我的表情!

    我非常喜欢新设计,它看起来好了一百倍。更棒的是社区可以自己编辑它。这正是所需要的,也是许多网站所需要的。

  2. 重新设计很棒,但是……您删除了 API 搜索字段中的写入 (keyup) 过滤功能。那是 API 文档中最好的功能 :(

  3. 您好,我很遗憾地看到该网站不再使用 Drupal,真是太可惜了。

    如果 Drupal 中有某些特定原因导致您无法使用它,我想听听原因(认真地说)。

    不过,新的设计非常棒!

  4. 非常棒的主题,与 Flash 和 Java 相比,jQuery 正在飞速发展。网站速度快得多,而且无需安装任何平台。这就是我从 Flash 转向 jQuery 的原因,我可以告诉你,它真的太棒了,而且在 Grunt 上工作非常有趣。