如何编写 MoveIt 教程

本指南介绍如何为 MoveIt 文档编写教程。 教程是您可以做出的最有用的贡献之一，因为它们是许多新用户看到的第一件事。 本指南适用于任何想要提交新教程的贡献者。 此存储库的 README 中还有许多其他质量标准和为教程做出贡献的方法。

学习目标

  • 教程中应包含的信息类型。

  • MoveIt 文档部分中教程的正确格式。

要求

  • Ubuntu 20.04

  • ROS 2 Galactic

  • MoveIt 2

步骤

  1. 分叉 MoveIt 2 教程存储库 并使用直观的名称（例如 jack/how-to-tutorials）开始一个新分支。

  2. 在 doc/tutorials 目录中创建一个带有 .rst 扩展名的新文件。标题应为简洁的描述（例如，“RViz 中的 MoveIt 快速入门”）。

  3. 在 教程页面 上添加指向您的教程的链接。

  4. 使用 reStructuredText (.rst) 按照以下准则编写简介：

  • 简介应解释本教程的目的和目标受众。

  • 如果您认为人们可能会经常错误地找到本指南，请添加指向适当资源的链接。

  1. 写下具体的学习目标（即，读者读完本教程后会知道什么）。

  2. 添加本教程的任何系统或设备要求，以便用户知道本教程是否适合他们。

  3. 布局要遵循的交互式步骤，并提供足够的细节，以便读者可以轻松跟进。

  4. 写一个结论来总结本教程并提供额外的资源。

  5. 添加读者应该遵循的下一个教程的链接。

  6. 将新页面作为 PR 提交到 MoveIt 2 教程存储库。

模板

<标题>

<本教程的简要说明，并附上图片以展示将要完成的内容。>

背景

<解释用户在学习本教程之前应该已经完成​​的操作。>

步骤

1. <第一步>

<这应该描述用户应该采取的操作，例如创建 ROS 项目或输入一些代码。>

1.1) <解释 第一步>

<使用类似这样的子步骤引导用户了解他们所做的事情。>

1.2) <操作 第一步>

<使用类似这样的子步骤描述运行新代码以及结果应该是什么。>

2. <第二步>

<…>

结论

<在这里您可以解释用户阅读的内容并提供其他参考。>

下一步

<此处链接到下一个教程。>

进一步阅读