<项目>．..文档是任何Jenkins插件的重要组成部分。必威国际有限公司它包括用户文档（插件页面，更改日志，用户指南等）和贡献者文档（如何贡献，开发人员指南等）。本节提供了这些文档类型的概述。
插件页面托管在插件网站．这些页面是使用最新插件版本和外部文档页面的元数据自动生成。可以从GitHub中检索外部文档或从必威国际有限公司Jenkins Wiki.．
我们建议将文档存储在插件的GitHub存储库中。它允许插件维护者从README页面和Jenkins插件站点提供相同的文档，同时它允许使用文档即代码技术，当文档是存储库的一部分时，因此所有常见的实践都可以应用:必威国际有限公司
拉出请求和评论
与特性并行创建文档
从Github Web UI编辑文档，具有预览支持
可以很容易地访问以前插件版本的版本控制和文档
插件站点可以从根README页面或从插件URL定义的其他位置获取文档(见下面)。支持多种格式:GitHub flavor Markdown, Asciidoc或原始文本。
在GitHub上发布插件文档:
创建一个自述文件并将插件文档放在那里。此页面将成为着陆页插件的网站．
可以在存储库内引入更多文档页面并链接到README中，插件站点将显示绝对和相对链接
Plugin网站也将显示来自页面的图像
修改你的项目URL以指向GitHub存储库，例如。https://github.com/必威国际有限公司jenkinsci/your-plugin．参见下面的Maven和Gradle指南。
发布新的插件版本。一旦插件的网站选择发布版本(可能需要几个小时)，它还会显示来自GitHub的文档。
文档的例子:
https://plugins.必威国际有限公司jenkins.io/configuration-as-code.使用Maven和Readme.md
https://plugins.必威国际有限公司jenkins.io/gradle使用gradle和README.adoc
https://plugins.必威国际有限公司jenkins.io/mailer使用maven和README.adoc
基于GitHub的文档的有效URL格式是
加载位于根的README你的插件主分支中的存储库
加载Readme位于根的根你的插件标签或分支中的存储库裁判
加载由路径指定的标记或ASCIIDOC文件你的插件存储库的标签或分支裁判．
如果使用Git标记进行版本，则可以通过将URL设置为例如，确保插件站点加载您的Readme的快照与上次版本相关。https://github.com/必威国际有限公司jenkinsci/ $ {project.artifactId} /树/ $ {project.artifactId} - ${修订}．
插件标签是由插件库的维护者分配给插件库的GitHub的话题．匹配的GitHub主题插件标签allowlist.显示在插件的网站．鼓励开发人员提交拉动请求插件标签allowlist.当他们检测到列表中的空白时。
我们鼓励插件维护人员将GitHub主题应用到他们维护的插件上。当插件与标签的关系远高于平均水平时，应该给插件分配主题。例如，git插件的标签是Git.和scm-connections但却没有标签bitbucket都，github，GitLab,或gitea．作为另一个示例，配置为代码插件允许配置许多插件，但不包括它可以配置所有插件的标签。
开发者不应该使用那些因为过度使用而失去价值的宽泛标签。例如，添加了一些Pipeline步骤的插件通常不应该被标记管道．插件的管道标签应该是Jenkins管道的重要贡献者。必威国际有限公司
必威国际有限公司Jenkins Wiki.在2019年11月成为只读。请求在Wiki上插入文档页面的请求现在重定向到插件的网站．看这一页为更多的信息。它还包括Wiki的GitHub迁移指南。
每个插件都列出了维护者信息插件的网站．它目前来自Maven元数据。
| 有一个使用的计划存储库权限 - updater,请参阅网站-658在问题跟踪器中。一旦实施，下面的指导方针就会改变。 |
在POM中，确保包含开发人员信息，例如:
<项目>．..<开发人员>开发人员> <<标识>exampleauthor.<名称>作者姓名<电子邮件>author@example.com< / >邮件< / >的开发人员> < /项目的ID是你的jenki必威国际有限公司ns.io帐户。的的名字是人类可读的显示名称。这可确保更新中心和相关工具能够正确显示插件的维护者。建议包含电子邮件地址，以便人们可以联系（这将在Wiki上的插件信息框中显示），但它是可选的。
一旦您完成了第一个版本，您应该向您的插件添加发行说明。您有许多选项如何进行：
使用GitHub版本(可能有帮助释放拖拉机），添加链接以将页面发布到文档页面（推荐）
在存储库根目录中创建一个CHANGELOG文件(Markdown, Asciidoc)，并从文档页面链接它
在文档页面中包含ChangeLog内容
对于开源插件，有贡献者指南对吸引更多贡献者来说很重要。GitHub提供了定义指南的标准方法，并将其向贡献者展示，包括贡献指南，行为准则，拉出请求模板等。
有些笔记：
贡献指南可以由插件维护者定义，我们目前没有设置默认指南。看设置存储库贡献者的指南想要查询更多的信息
必威国际有限公司詹金斯有的行为准则它适用于所有贡献者和项目托管的所有组件。属性为所有存储库定义必威国际有限公司Jenkinsci / .github.库，插件维护者不需要设置它。
拉请求模板:见为您的存储库创建一个拉取请求模板．