这是MuleSoft文档的存储库，包含 docs网站的源内容。
MuleSoft欢迎来自社区的贡献！您可以通过以下方式为我们的文档提供或提供反馈意见：
-
分发此存储库，进行编辑并提交请求。我们尽快回复您的请求。
-
提出问题。尽可能详细地说明您希望看到的更改。
-
在我们的 docs网站上查看网页时，您可以对特定主题进行评分，并对修正，建议或一般反馈进行评论。
-
发送邮件至文档团队：documentation@mulesoft.com
-
请参阅[MuleSoft Docs Style Guide]书写提示。
在您可以撰写我们的文档之前，您需要完成两个步骤来确认您已阅读并接受了我们的贡献者协议：
-
查看协议，该协议是 可在这里。
-
在您阅读并同意该协议后，您需要填写https://api-notebook.anypoint.mulesoft.com/notebooks/#380297ed0e474010ff43 [MuleSoft贡献者协议]表单并将其提交给我们。这个表单作为一个API笔记本存在，并做两件事情：
-
标识您使用您的GitHub帐户和
-
将您的姓名记录为贡献者
-
提交表单后，系统会要求您向GitHub进行身份验证并接受我们的贡献者协议。脚本完成后，我们的撰稿人的项目中会以您的名字创建一个问题。
而已！您现在可以对我们的文档做出贡献。准备好开始了吗？
在您接受我们的贡献者协议后，您可以简单地分叉我们的文档库并进行更改，然后提交拉取请求。
或者，您也可以点击页面顶部的*Edit on GitHub*链接，点击铅笔图标并进行更改。
我们的团队尽快审查拉式要求。
该存储库包含一个Gradle构建脚本，您可以使用该脚本构建用于本地预览的文档站点。 该脚本自动化了构建的所有方面。 在您的机器上执行构建所需的所有东西都是Java Development Kit（又名java和javac）。
从克隆文档库开始：
$ git clone git@github.com:mulesoft/mulesoft-docs.git
*Note:*如果您对整个历史记录不感兴趣，并且想要缩小克隆的大小，请添加`--depth`标志以执行浅层克隆：
$ git clone --depth 1 git@github.com:mulesoft/mulesoft-docs.git
接下来，切换到您克隆存储库的目录：
$ cd mulesoft-docs
最后，使用`gradlew`命令启动Gradle并执行网站构建器：
$ ./gradlew
运行不带参数的`gradlew`将执行名为build的默认任务。 它相当于以下内容：
$ ./gradlew build
（构建任务可能需要几分钟才能完成）。
一旦你建立了网站，你可以再次使用Gradle来使用本地的内存中的Web服务器来为网站提供服务：
$ ./gradlew serve
您现在可以从位于`http://localhost:8000`的浏览器访问该网站。
*Note:*目前，由于预览服务器没有实现生产中使用的重写规则，因此并非所有链接都在本地预览中工作。 如果您点击网站导航中的链接时遇到404，请尝试将".html"添加到地址栏中的网址。
当你想停止预览服务器时，只需按下kbd：[Ctrl + c]。
要一次运行完整版本并启动预览服务器，请合并`build`和`serve`个任务：
$ ./gradlew build serve
该存储库包含一个Gradle构建脚本，您可以使用该脚本为本地预览构建文档页面。
./gradlew buildHtmlSingle -Pfile=<asciidoc-filepath>
Gradle构建脚本还能够构建用于分段并将输出同步到登台服务器的站点。 当`profile`属性的值为`staging`时，会添加这些操作所需的额外任务和配置。 您可以通过将标志`-Pprofile=staging`传递给`gradlew`启动命令来设置此属性。
要指示Gradle清理，构建和发布暂存站点，请执行以下命令：
$ ./gradlew clean publish -Pprofile=staging
*Note:*中转站点将来自mule-docs-site-assets的分期分支的资产与来自mule-docs主分支的内容结合起来。
Gradle构建脚本还能够构建生产站点并将其发布到git。 当`profile`属性的值为`prod`时，会添加这些操作所需的额外任务和配置。 您可以通过将标志`-Pprofile=prod`传递给`gradlew`启动命令来设置此属性。
要指示Gradle清理，构建和发布生产站点，请执行以下命令：
$ ./gradlew clean publish -Pprofile=prod
Notes:
-
第一次执行此命令时，它可能会运行很长时间（取决于连接速度），因为它必须重新克隆publish（aka build output）存储库。
-
为防止发布任务将新提交推送到远程存储库，请将标记`-PdryRun`传递给`gradlew`启动命令。
以下部分描述了MuleSoft Docs发布风格。
| 样式 | 正确的示例 | 不正确的示例 |
|---|---|---|
使用活动文本替代"will"，"you’ll"，"won’t"或"we’ll"。 |
此功能将初始化并合并您的代码。 |
此功能将初始化并合并您的代码。 |
在插图和代码中 |
混淆登录凭据客户端密码为4242424242424242-ABADDOG |
我的密码为foobar123 |
仅使用RFC-1918 IP地址，例如IPv4地址：+ 10.0.0.0 - 10.255.255.255（10/8前缀）+ 172.16.0.0 - 172.31.255.255（172.16 / 12前缀）+ 192.168.0.0 - 192.168.255.255（192.168 / 16前缀） |
将服务器地址设置为10.1.1.42 |
例如，将地址设置为42.42.42.42。 |
使用example.com域名 |
||
省略"please" |
联系MuleSoft客户支持。 |
请联系MuleSoft客户支持。 |
用>分隔选项，不要以粗体 |
文件>文件>新建> Mule Project |
File → New → Mule Project |
将"in order to"替换为"to" |
要开始此过程，请 |
为了启动过程 |
省略"then" |
点击此并且 |
点击此，然后点击 |
将内嵌文本中的变量称为字符串文字 |
|
"replayID"，replayID |
忽略按钮省略号 |
点击测试连接。 |
点击*Test Connections…*。 |
点击 |
忽略"on"点击测试连接。 |
点击*Test Connections*。 |
标题中的首字母大写字词 |
默认值设置 |
默认值设置 |
详细说明，例如 |
为Salesforce创建连接器 |
创建连接器，例如。为Salesforce |
请勿将代码示例放入屏幕截图 |
将代码放入源块 |
屏幕截图 |
在引号字符串外加一段时间 |
不要说"will"。 |
不要说"will." |
使用牛津逗号 |
a，b和c |
a，b和c |
省略商标符号 |
Anypoint Platform |
Anypoint™Platform™ |
-
仅使用[％header％autowidth.spread]启动表格 - 这会自动设置表格和列的宽度。
-
使用`|===`开始和结束表格 - 添加额外的等号只会产生更复杂的来源，并将不必要的字符添加到文件中。
-
请勿使用`[tabs]`符号。为使用可视化编辑器进行配置和使用XML编辑器或独立进行配置提供单独的部分。
-
省略单行代码示例中的`linenums`选项。
-
将多个单词的示例放在一个源块中，而不是一个长的标记为tick的字符串。
-
只有XML或XML过程可以位于XML选项卡中。在XML选项卡中放入截图是不合逻辑的。
-
将表限制为2列或3列 - 多列表可能非常难以阅读。
-
在空格处包装代码示例行，或在点后包装Java。代码行应小于60个字符，特别是如果您使用`// <n>`符号进行标注
-
不要通过行号引用代码示例。 请改用代码示例中的`// <n>`，并在代码示例下面的文本中引用符号。
-
AsciiDoc源代码中使用子弹符号（U + 2022）作为标记的列表被识别为列表。
| {规则{1}}说明 | 示例 |
|---|---|
在列表之前命令 |
在开始列表之前，请提供以"to"开头的开始句子 描述你希望人们提供的任务。此外，不要在没有起始句子的标题之后开始项目符号或编号列表。 |
要设置值： |
在句子或项目符号列表项 |
的末尾插入句点执行这些任务。 |
执行这些任务 |
以大写字母 |
开始项目符号列表或编号列表中的每个项目启动不带保留首字母大写的保留字的列表项 |
*确保设置了所有必填字段。 |
开始具有操作的号码列表项目 |
号码列表项目仅以Click，Set等操作开始 |
1。点击加号 请在*Connector Configuration*右侧标志。 |
除*Note:*外，请勿使用字体更改。如果引用字段，则不管UI中的显示如何，都要首先大写每个字的每个字母。例如，不要使用*Connector Configuration*，而要使用“连接器配置”。
-
描述程序性内容的部分必须以“To”开头，例如“配置连接器”。
-
描述概念的章节必须以About开头，例如关于连接器。
-
标题中没有特殊字符。
-
初始化标题中的每个单词。
-
不要在标题末尾添加冒号。
-
确保标题按顺序排列，h1> h2> h3> h4。不要跳过像h2> h5这样的级别。
-
文件顶部每个文档只有一个H1。
-
不要为数字标题编号。