帮酷LOGO
  • 显示原文与译文双语对照的内容
文章标签:MULE  MAIN  rep  Repository  REPO  DOC  
Main MuleSoft documentation repository

  • 源代码名称:mulesoft-docs
  • 源代码网址:http://www.github.com/mulesoft/mulesoft-docs
  • mulesoft-docs源代码文档
  • mulesoft-docs源代码下载
  • Git URL:
    git://www.github.com/mulesoft/mulesoft-docs.git
  • Git Clone代码到本地:
    git clone http://www.github.com/mulesoft/mulesoft-docs
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/mulesoft/mulesoft-docs
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • MuleSoft文档存储库

    这是mulesoft文档的存储库,包含文档站点的源内容。

    社区贡献

    MuleSoft欢迎来自社区的贡献 ! 你可以通过以下方式为我们的文档提供或者提供反馈:

    接受参与者的协议

    在你提供我们的文档之前,你需要完成两个步骤,以确认你已经阅读并接受了我们的参与者:

    查看协议,这在这里是的。

    阅读并同意协议后,你需要填写 contributor 表单的 MuleSoft协议并提交给我们。 这里表单作为一个API笔记本存在,并且执行两种操作:

    • 确定你使用的是你的GitHub帐户,

    • 将你的NAME 记录为贡献者

    提交表单之后,要求你对GitHub进行身份验证并接受我们的参与者协议。 脚本完成后,会在我们的贡献者的项目中创建一个问题。

    就是这样你现在可以对我们的文档做出贡献了。 准备好开始了吗?

    做出贡献

    接受我们的参与者协议之后,你可以以简单地 fork 文档存储库并进行更改,然后提交请求。

    或者,点击页面顶部的链接,点击铅笔,然后修改你的页面。

    我们的团队将尽快审查拉请求。

    构建本地预览站点

    这个库包含一个Gradle构建脚本,你可以使用它来构建本地预览的文档站点。 脚本自动化了构建的所有方面。 你在机器上执行构建所需要的全部是Java开发工具包( 。Java和 javac ) 。

    首先克隆文档存储库:

    $ git clone git@github.com:mulesoft/mulesoft-docs.git

    注意:如果你对整个历史记录不感兴趣,并且希望减小克隆的大小,则添加 --depth 标志以执行浅表克隆:

    $ git clone --depth 1 git@github.com:mulesoft/mulesoft-docs.git

    接下来,switch 到你克隆存储库的目录:

    $ cd mulesoft-docs

    最后,使用 gradlew 命令启动Gradle并执行站点生成器:

    $./gradlew

    运行不带参数的gradlew 将执行默认任务,该任务名为 build"。 它与以下内容等效:

    $./gradlew build

    ( 生成任务可能需要几分钟才能完成) 。

    生成站点后,可以以再次使用Gradle在内存web服务器中使用本地服务器:

    $./gradlew serve

    现在,你可以从浏览器访问位置 http://localhost:8000 中的站点。

    注意:目前不是所有链接都在本地预览中工作,因为预览服务器不执行生产中使用的重写规则。 如果在站点导航中单击链接时遇到 404,请尝试将". html"添加到位置栏中的URL 。

    当你想停止预览服务器时,只需按 Ctrl+c 。

    要运行完整的构建并一次性启动预览服务器,请将 buildserve 任务组合在一起:

    $./gradlew build serve

    为本地预览生成页面

    这个库包含Gradle构建脚本,你可以使用它为本地预览构建文档页面。

    ./gradlew buildHtmlSingle -Pfile=<asciidoc-filepath>

    构建用于登台的站点

    Gradle构建脚本还能够构建用于暂停和同步输出到临时服务器的站点。 这些操作需要的额外任务和配置在 profile 属性具有 staging 属性时添加。 你可以通过将标志 -Pprofile=staging 传递给 gradlew 启动命令来设置这里属性。

    要指示Gradle清理,生成和发布临时站点,请执行以下命令:

    $./gradlew clean publish -Pprofile=staging

    注意:staging将来自mule-docs-site-assets登台分支的资产与文档主分支的内容结合起来。

    构建生产站点

    Gradle构建脚本还能够生成生产站点并将它的发布到 git 。 这些操作需要的额外任务和配置在 profile 属性具有 prod 属性时添加。 你可以通过将标志 -Pprofile=prod 传递给 gradlew 启动命令来设置这里属性。

    要指示Gradle清理,生成和发布生产站点,请执行以下命令:

    $./gradlew clean publish -Pprofile=prod

    备注:

    • 第一次执行这里命令时,可能会运行很长时间( 取决于连接速度),因为它必须重新克隆发布( 。aka生成输出) 存储库。

    • 为了防止发布任务将新提交推到远程存储库,请将标志 -PdryRun 传递到 gradlew 启动命令。

    MuleSoft文档样式指南

    以下部分描述MuleSoft文档发布样式。

    电子邮件内容

    样式正确示例错误示例

    使用活动文本而不是"将将","你',","赢得't"或者"我们',。

    这里功能初始化并合并你的代码。

    这里功能将初始化并合并你的代码。

    在插图和代码中混淆登录凭据

    客户端密钥为 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 域

    例如 mydomain@example.com

    myname@mycompany.com

    请省略"请"

    联系MuleSoft客户支持。

    请联系MuleSoft客户支持。

    使用> 单独选项,不要将字符串强制转换为粗体

    文件> 新的> Mule项目

    文件→新→项目

    将"为了"替换为""

    要开始这个过程

    为了启动这个程序

    省略""

    单击这里选项

    单击这里按钮,然后单击

    将 inline 文本中的变量作为字符串字符串引用

    replayID

    replayID,replayID

    省略按钮省略号

    单击测试连接。

    单击"打开"忽略

    单击测试连接。

    点击测试连接

    标题中的初始大写单词

    默认值设置

    默认值设置

    拼写 换句话说,和 e.g.

    创建一个连接器,例如 Salesforce

    创建一个连接器,比如

    不要将代码示例放在屏幕截图中

    将代码放入源块中

    屏幕截图

    在引号字符串外放置句号

    不要说"将将"。

    不要说"威尔""

    使用牛津逗号

    a,b 和c

    a,b 和c

    省略商标符号

    Anypoint平台

    AsciiDoc约定

    • 不使用 [tabs] 表示法。 使用可视编辑器提供单独的节,并使用XML编辑器或者独立配置配置。

    • 在 1行代码示例中省略 linenums 选项。

    • 将多个单词示例放在源 block 中,而不是一个。

    • XML选项卡中只能包含XML或者XML过程。 在XML标签中放置一个截屏是不合理的。

    • 将表限制为 2或者 3列- multi列表可能很难读取。

    • 在空格处包装代码示例行,或者在小数点后为Java换行。 代码行应小于 60个字符,特别是如果使用 //<n> 标记的索引符号

    • 不按行号引用代码示例。 在代码示例中使用 //<n>,并在文本 below 中引用符号示例。

    • AsciiDoc源中使用项目符号符号( U+2022 ) 作为列表的列表被识别为列表。

    下拉列表

    规则说明示例

    列表前的命令

    在开始一个列表之前,提供一个从"到"开始的起始句,描述你希望人们提供的任务。 此外,在没有起始句的标题后,不要启动项目符号或者编号列表。

    要设置值:

    在句子或者项目符号列表项的末尾插入句号

    执行这些任务。

    执行这些任务

    用大写字母在项目符号列表或者编号列表中启动每个项目

    开始列表项与初始大写一起使用的未保留单词

    * 确保设置了所有必需的字段。

    使用操作开始编号列表项

    编号列表项仅从单击。设置等操作开始。

    1.单击连接器配置右侧的加号。

    字体更改

    不要使用字体更改,除非注意英镑: 如果引用某个字段,则初始大写每个单词的每个字母,而不管用户界面中显示的是如何。 例如使用连接器配置代替连接器配置

    标题

    • 描述程序内容的部分必须从开始,例如配置连接器。

    • 描述概念的部分必须从About开始,比如连接器。

    • 标题中没有特殊字符。

    • 初始化标题中的每个单词。

    • 标题末尾不要放冒号。

    • 确保标题有序,h1>>> h4. 不要跳过诸如 h2> h5之类的级别。

    • 文件顶部每个文档只有一个 H1.

    • 不编号标题。

    字词选择

    • Json不是 Json

    • Pojo不是Pojo或者 Pojo

    • 魔术不是魔术或者魔术

    • Id不标识或者 Id

    • JAVA不是 JAVA

    • Anypoint工作室不是Mule工作室

    不要写出常见的缩写词,如 POJO 。JSON 。MOJO 。REST 。SOAP 。MQ 。UI 。IP 。tcp/IP 。



    文章标签:rep  DOC  REPO  Repository  MAIN  MULE  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语