Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated link to Noetic tutorial #823

Merged
merged 4 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Please explain the changes you made, including a reference to the related issue

### Checklist
- [ ] **Required by CI**: Code is auto formatted using [clang-format](http://moveit.ros.org/documentation/contributing/code)
- [ ] While waiting for someone to review your request, please consider reviewing [another open pull request](https://github.com/ros-planning/moveit/pulls) to support the maintainers
- [ ] While waiting for someone to review your request, please consider reviewing [another open pull request](https://github.com/moveit/moveit/pulls) to support the maintainers

[//]: # "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread. Thank you!"
6 changes: 3 additions & 3 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
if: github.repository_owner == 'ros-planning'
if: github.repository_owner == 'moveit'
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3'
Expand All @@ -33,12 +33,12 @@ jobs:

- name: Upload pages artifact
uses: actions/upload-pages-artifact@v3
if: github.repository_owner == 'ros-planning'
if: github.repository_owner == 'moveit'
with:
path: build/html

deploy:
if: github.repository_owner == 'ros-planning' && github.ref == 'refs/heads/master'
if: github.repository_owner == 'moveit' && github.ref == 'refs/heads/master'
runs-on: ubuntu-latest
needs: doc
environment:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# MoveIt Tutorials

[MoveIt 1 Live tutorials](https://ros-planning.github.io/moveit_tutorials/)
[MoveIt 1 Live tutorials](https://moveit.github.io/moveit_tutorials/)

*These are the tutorials for MoveIt 1, for MoveIt 2 see [MoveIt 2 Tutorials](https://github.com/ros-planning/moveit2_tutorials/)*
*These are the tutorials for MoveIt 1, for MoveIt 2 see [MoveIt 2 Tutorials](https://github.com/moveit/moveit2_tutorials/)*

This is the primary documentation for the MoveIt project. We strongly encourage you to help improve MoveIt's documentation. Please consider reading the guidelines below for writing the best documentation and tutorials. However, if you are uncomfortable with any of the approaches, simply adding documentation text to your pull requests is better than nothing.

Expand All @@ -12,7 +12,7 @@ All content in this repository is open source and released under the [BSD Licens

This repository is currently built automatically by two systems. Github Actions builds the documentation for Noetic, and ROS Build Farm builds the documentation for older versions:

- [ROS Noetic](https://ros-planning.github.io/moveit_tutorials/): [![CI](https://github.com/ros-planning/moveit_tutorials/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/ros-planning/moveit_tutorials/actions/workflows/ci.yaml?query=branch%3Amaster) [![Deploy](https://github.com/ros-planning/moveit_tutorials/actions/workflows/deploy.yaml/badge.svg?branch=master)](https://github.com/ros-planning/moveit_tutorials/actions/workflows/deploy.yaml?query=branch%3Amaster) [![Formatting](https://github.com/ros-planning/moveit_tutorials/actions/workflows/format.yaml/badge.svg?branch=master)](https://github.com/ros-planning/moveit_tutorials/actions/workflows/format.yaml?query=branch%3Amaster)
- [ROS Noetic](https://moveit.github.io/moveit_tutorials/): [![CI](https://github.com/moveit/moveit_tutorials/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/moveit/moveit_tutorials/actions/workflows/ci.yaml?query=branch%3Amaster) [![Deploy](https://github.com/moveit/moveit_tutorials/actions/workflows/deploy.yaml/badge.svg?branch=master)](https://github.com/moveit/moveit_tutorials/actions/workflows/deploy.yaml?query=branch%3Amaster) [![Formatting](https://github.com/moveit/moveit_tutorials/actions/workflows/format.yaml/badge.svg?branch=master)](https://github.com/moveit/moveit_tutorials/actions/workflows/format.yaml?query=branch%3Amaster)
- [ROS Melodic](http://docs.ros.org/melodic/api/moveit_tutorials/html/): [![build farm](http://build.ros.org/buildStatus/icon?job=Mdoc__moveit_tutorials__ubuntu_bionic_amd64)](http://build.ros.org/job/Mdoc__moveit_tutorials__ubuntu_bionic_amd64/)
- [ROS Kinetic](http://docs.ros.org/kinetic/api/moveit_tutorials/html/): [![build farm](http://build.ros.org/buildStatus/icon?job=Kdoc__moveit_tutorials__ubuntu_xenial_amd64)](http://build.ros.org/job/Kdoc__moveit_tutorials__ubuntu_xenial_amd64/)

Expand Down Expand Up @@ -43,7 +43,7 @@ For deploying documentation changes to the web, [Section 3 of the rosdoc_lite wi

## Contributing

We rely on the community to keep these tutorials up-to-date and bug-free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit_tutorials/issues/new) or open a PR with the proposed changes.
We rely on the community to keep these tutorials up-to-date and bug-free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/moveit/moveit_tutorials/issues/new) or open a PR with the proposed changes.

### Formatting and Style

Expand Down
2 changes: 1 addition & 1 deletion _themes/sphinx_rtd_theme/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
<div itemprop="articleBody">
<!-- <div class="admonition note"> -->
<!-- <p class="first admonition-title">Code Used in this Tutorial Available</p> -->
<!-- <p class="last">Code can be found at <a href = "https://github.com/ros-planning/moveit_tutorials">moveit_tutorials repository</a> in doc folder. Use master branch.</p> -->
<!-- <p class="last">Code can be found at <a href = "https://github.com/moveit/moveit_tutorials">moveit_tutorials repository</a> in doc folder. Use master branch.</p> -->
<!-- </div> -->
{% block body %}{% endblock %}
{% if display_github %}
Expand Down
2 changes: 1 addition & 1 deletion _themes/sphinx_rtd_theme/versions.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<div class="rst-other-versions">
<dl>
<dt>Current Versions</dt>
<dd><a href="https://ros-planning.github.io/moveit_tutorials/">Noetic</a></dd>
<dd><a href="https://moveit.github.io/moveit_tutorials/">Noetic</a></dd>
<dd><a href="http://docs.ros.org/en/melodic/api/moveit_tutorials/html/index.html">Melodic</a></dd>
</dl>
<dl>
Expand Down
4 changes: 2 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@

html_context = {
"display_github": True,
"github_user": "ros-planning",
"github_user": "moveit",
"github_repo": "moveit_tutorials",
"github_version": "master",
"conf_py_path": "",
"source_suffix": source_suffix,
"css_files": ["_static/override.css"],
"favicon": "favicon.ico"
"favicon": "favicon.ico",
# "logo": "logo.png"
}

Expand Down
2 changes: 1 addition & 1 deletion doc/benchmarking/benchmarking_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The example below demonstrates how the benchmarking can be run for a Panda robot
Example
-------
An example is provided in the ``examples`` folder. The launch file requires a MoveIt configuration package
for the Panda robot arm available from `here <https://github.com/ros-planning/panda_moveit_config>`_.
for the Panda robot arm available from `here <https://github.com/moveit/panda_moveit_config>`_.

To run:

Expand Down
6 changes: 3 additions & 3 deletions doc/chomp_planner/chomp_planner_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CHOMP Planner
.. image:: chomp.png
:width: 700px

Covariant Hamiltonian optimization for motion planning (CHOMP) is a gradient-based trajectory optimization procedure that makes many everyday motion planning problems both simple and trainable (Ratliff et al., 2009c). While most high-dimensional motion planners separate trajectory generation into distinct planning and optimization stages, this algorithm capitalizes on covariant gradient and functional gradient approaches to the optimization stage to design a motion planning algorithm based entirely on trajectory optimization. Given an infeasible naive trajectory, CHOMP reacts to the surrounding environment to quickly pull the trajectory out of collision while simultaneously optimizing dynamical quantities such as joint velocities and accelerations. It rapidly converges to a smooth collision-free trajectory that can be executed efficiently on the robot. Integration into latest version of MoveIt is `work in progress <https://github.com/ros-planning/moveit/issues/702>`_. `More info <http://www.nathanratliff.com/thesis-research/chomp>`_
Covariant Hamiltonian optimization for motion planning (CHOMP) is a gradient-based trajectory optimization procedure that makes many everyday motion planning problems both simple and trainable (Ratliff et al., 2009c). While most high-dimensional motion planners separate trajectory generation into distinct planning and optimization stages, this algorithm capitalizes on covariant gradient and functional gradient approaches to the optimization stage to design a motion planning algorithm based entirely on trajectory optimization. Given an infeasible naive trajectory, CHOMP reacts to the surrounding environment to quickly pull the trajectory out of collision while simultaneously optimizing dynamical quantities such as joint velocities and accelerations. It rapidly converges to a smooth collision-free trajectory that can be executed efficiently on the robot. Integration into latest version of MoveIt is `work in progress <https://github.com/moveit/moveit/issues/702>`_. `More info <http://www.nathanratliff.com/thesis-research/chomp>`_

Getting Started
---------------
Expand All @@ -19,7 +19,7 @@ Prerequisites

Using CHOMP with Your Robot
---------------------------
**Note:** if you are following this demo using the ``panda_moveit_config`` from the `ros-planning/panda_moveit_config <https://github.com/ros-planning/panda_moveit_config>`_ repository, these steps are already done for you and you can skip this section.
**Note:** if you are following this demo using the ``panda_moveit_config`` from the `moveit/panda_moveit_config <https://github.com/moveit/panda_moveit_config>`_ repository, these steps are already done for you and you can skip this section.

#. Simply download :panda_codedir:`chomp_planning_pipeline.launch.xml<launch/chomp_planning_pipeline.launch.xml>` file into the launch directory of your MoveIt config package. In our case, we will save this file in the ``panda_moveit_config/launch`` directory.
#. Adjust the line ``<rosparam command="load" file="$(find panda_moveit_config)/config/chomp_planning.yaml" />`` to ``<rosparam command="load" file="$(find <robot_moveit_config>)/config/chomp_planning.yaml" />`` replacing ``<robot_moveit_config>`` with the name of your MoveIt configuration package.
Expand All @@ -28,7 +28,7 @@ Using CHOMP with Your Robot

Running the Demo
----------------
If you have the ``panda_moveit_config`` from the `ros-planning/panda_moveit_config <https://github.com/ros-planning/panda_moveit_config>`_ repository you should be able to simply run the demo: ::
If you have the ``panda_moveit_config`` from the `moveit/panda_moveit_config <https://github.com/moveit/panda_moveit_config>`_ repository you should be able to simply run the demo: ::

roslaunch panda_moveit_config demo.launch pipeline:=chomp

Expand Down
Loading