创建 Groovy 博客文章

作者:Paul King
发布时间:2023-05-25 11:35PM


Groovy 项目欢迎社区对与 Groovy 相关的任何主题做出贡献,包括以下内容的帖子:

  • 突出显示您认为值得额外关注的 Groovy 语言功能

  • 提供有关使用 Groovy 工具的详细信息

  • 提供有关将 Groovy 与其他工具、库或框架一起使用的详细信息

  • 为 Groovy 新用户提供建议

Groovy 网站 上所述,您可以使用自己的博客平台,也可以将帖子添加到 Groovy 的 博客网站。这篇博文将更详细地介绍第二个选项。

总结来说,如果您了解 Asciidoc 和 git 的基础知识,那么编写博客就很容易。博客通常只是一个添加到 博客部分apache/groovy-website GitHub 仓库中的 asciidoc 文件,以及对应 图像 目录中的一个或多个图像。

使用命令行

如果您已经熟悉 git,首先使用 WebUI 分叉仓库。然后以常规方式在命令行中克隆仓库

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

或者,如果您安装了 GitHub CLI 工具,则可以使用以下命令一步完成分叉和克隆:

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

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

您需要按照所有正常的步骤 在 GitHub 上创建拉取请求。这通常包括创建分支,提交您的新文件(以及可能的一些图像),将您的分支推送到您的分叉仓库,然后创建实际的 PR。

使用 GitHub WebUI

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

Clicking Add file → Create new file

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

Entering the new file name

您通常会选择一个不长且唯一的名称。在这里我们选择了 create-groovy-blog.adoc。不要太担心名称,如果您的名称与现有名称相比显得不合适,我们会在您提交 PR 后提供进一步的指导。我们通常避免在文件名中使用像表情符号这样的奇特字符。某些工具不喜欢这样的字符。

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

Entering some content

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

完成后,点击“提交更改…”

click commit changes

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

forking the repo

接下来,您可以选择覆盖默认的提交消息,并根据需要提供可选的扩展描述

confirm commit

准备就绪后,点击“提出更改”。

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

create pull request

根据需要添加评论,最后点击“创建拉取请求”。

您的 PR 现在应该列在仓库的拉取请求中

选择您的内容

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

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

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

后续步骤

接受过程可能需要多次迭代才能改进内容。

您的 PR 一旦被接受,就会合并到仓库中。此时,CI 作业将启动并构建网站的新版本。您可以在此处观看 CI 进度

最终结果将显示在此处