创建或贡献入门指南比以往任何时候都更容易

工程 | Greg L. Turnquist | 2014 年 1 月 23 日 | ...

Spring 社区的各位,大家好!

我们不断收到反馈,Spring 的 入门指南非常受欢迎。

到目前为止,我们已将这些指南迁移到 Asciidoctor。 我们也已经扩展了我们的指南,包括 面向客户端的指南。 更多内容即将推出!

使这些指南长期有效的最后一步是每个指南侧边栏中的导航链接。 我们现在使用元数据来标记和链接各种指南,同时将它们连接到相关的项目。

例如,如果您访问 使用 AngularJS 消费 RESTful Web 服务,您将看到一个包含以下内容的侧边栏

  • 该指南的顶级部分的快捷方式
  • 两个标签:restJavaScript,这些链接可让您搜索包含相同标签的其他指南
  • 指向 Spring Framework 项目的链接,因为本指南侧重于将 Spring MVC 与 AngularJS 结合使用
  • 指向 理解 REST理解 JSON 的链接

侧边栏现在需要 维护。

注意: 如果我喜欢什么,那就是零维护!

如果您要为我们的指南之一做出贡献,您不再需要编辑关于侧边栏的单独文件。 相反,每个指南的顶部都标有 标签项目 元数据。 这就是构建侧边栏上导航链接所需的全部内容。

这使得发布一批新的相关指南变得比以往任何时候都更容易,这些指南通过一些共同的链接链接在一起。 例如,查看所有 Spring Data 指南

当您访问指南列表时,您可以基于标题和指南描述以及标签进行即时搜索。 正如您从上面的所有链接中看到的那样,搜索条件可以被书签、捕获和保存。

注意: 标签数据可能会更改,因此不要假设它是永久的。

通过对指南的创建和管理方式的所有这些更新,创建新指南或编辑现有指南的过程比以往任何时候都简单。

如果您对新指南有想法,您可以在您自己的 github 存储库中进行开发。 请务必查看我们的 模板项目 以及 写作指南,以了解写作、编辑和贡献的过程。

我们渴望看到您的贡献,并且也将传播消息,以便各个 Spring 负责人可以为他们的项目编写更多指南。

获取 Spring 新闻简报

通过 Spring 新闻简报保持联系

订阅

领先一步

VMware 提供培训和认证,以加速您的进步。

了解更多

获得支持

Tanzu Spring 在一个简单的订阅中提供对 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件。

了解更多

即将举行的活动

查看 Spring 社区中所有即将举行的活动。

查看全部