创建一篇 Groovy™ 博客文章

作者: Paul King

发布时间:2023-05-25 11:35 PM


Groovy 项目欢迎社区对任何与 Groovy 相关的主题做出贡献,包括以下类型的文章:

  • 突出显示你认为值得额外关注的 Groovy 语言特性

  • 详细介绍如何使用 Groovy 的工具

  • 详细介绍如何将 Groovy 与其他工具、库或框架结合使用

  • 为 Groovy 新用户提供建议

Groovy 网站上所述,你可以选择使用自己的博客平台,或者在 Groovy 自己的博客网站上添加文章。本文将详细介绍第二种选项。

总而言之,如果你了解 Asciidoc 和 git 的基本知识,编写博客文章会很简单。博客文章通常只是一个 Asciidoc 文件,添加到 apache/groovy-website GitHub 仓库的博客部分,可能还会在相应的图片目录中添加一两张图片。

使用命令行

如果你已经熟悉 git,请首先使用 WebUI fork 该仓库。然后以常规方式在命令行上克隆该仓库

$ git clone https://github.com/apache/groovy-website.git

或者,如果你安装了 GitHub CLI 工具,你可以通过以下方式一步完成 fork 和克隆:

$ gh repo fork https://github.com/apache/groovy-website.git --clone

现在在 site/src/site/blog/ 目录中创建一个新的 .adoc 文件。你可以使用你喜欢的文本/Asciidoc 编辑器或 IDE 编辑该文件。我通常使用带 Asciidoc 插件Intellij IDEA

你需要遵循所有正常步骤来在 GitHub 上创建拉取请求。这通常包括创建分支、提交新文件(可能还有图片)、将分支推送到你的 fork,然后创建实际的 PR。

使用 GitHub WebUI

如果你不想安装 git 和编辑器/IDE,你可以使用 WebUI。只需导航到仓库,进入 site/src/site/blog/ 文件夹,然后在 Add file 下点击 Create new file。它应该看起来像下面的图片

Clicking Add file → Create new file

系统将提示你为文件输入一个合适的名称

Entering the new file name

你通常会选择一个不长的唯一名称。这里我们选择了 create-groovy-blog.adoc。不要太纠结于名称,一旦你的 PR 提交,如果你的名称与现有名称相比显得格格不入,我们可以提供进一步的指导。我们通常会避免在文件名中使用表情符号等特殊字符。有些工具不喜欢此类字符。

现在我们在文件中输入 Asciidoc 内容

Entering some content

第一行是帖子的标题。第二行是作者(或多位作者)。接下来的几行包含元数据。最好的办法是复制现有帖子的元数据并相应地进行更改,但如果需要,我们将在 PR 提交后指导你进行任何更改。

完成后,点击“Commit changes…”

click commit changes

如果你之前没有分叉过仓库,系统可能会提示你现在进行分叉

forking the repo

接下来,你可以选择覆盖默认提交消息并提供可选的扩展描述(如果需要)

confirm commit

准备好后,点击“Propose changes”。

你现在应该能看到你的拉取请求的摘要。

create pull request

如果需要,添加评论,最后点击“Create pull request”。

你的 PR 现在应该列在仓库的拉取请求下

选择你的内容

如前所述,我们欢迎各种主题的帖子。并非所有主题都适合。我们需要确保我们发布的任何内容都符合正常的版权限制,并且可以在 Apache 许可下发布。此外,我们通常不希望出现重复内容或性质过于商业化的内容。

如有疑问,在创建 PR 之前,最好先在邮件列表或 Slack 频道上与 Apache Groovy 团队进行简短的交流。有关联系团队的更多详细信息,请访问参与页面

如果你的帖子从其他网站或内容中汲取灵感,请务必提供适当的署名。最后,请确保你在撰写帖子时玩得开心。这将让你和我们的读者都感到更愉快!

下一步

接受过程可能涉及多次迭代以改进内容。

你的 PR 一旦被接受,将被合并到仓库中。此时,CI 任务将启动并构建网站的新版本。你可以在此处查看 CI 进度

最终结果将出现在这里