diff --git a/source/Mirrors.rst b/source/Mirrors.rst new file mode 100644 index 00000000000..5c447e2afca --- /dev/null +++ b/source/Mirrors.rst @@ -0,0 +1,14 @@ +Mirrors +======= + +A ROS mirror site, or "mirror" for short, is an un-official secondary source of ROS binaries from which users can install their ROS packages. +A mirror site has its own URL but is otherwise identical to the principal site. +Installing ROS from a mirror can greatly speed up the time it takes to download and install ROS. + +.. toctree:: + :maxdepth: 1 + + Mirrors/List-of-mirrors-and-their-usage + Mirrors/Adding-your-mirror + Mirrors/Creating-your-own-ROS-mirror + Mirrors/Mirroring-ROS-documentation diff --git a/source/Mirrors/Adding-your-mirror.rst b/source/Mirrors/Adding-your-mirror.rst new file mode 100644 index 00000000000..09d00e58b2e --- /dev/null +++ b/source/Mirrors/Adding-your-mirror.rst @@ -0,0 +1,4 @@ +Adding Your ROS 2 Mirror +======================== + +Add more text here. diff --git a/source/Mirrors/Creating-your-own-ROS-mirror.rst b/source/Mirrors/Creating-your-own-ROS-mirror.rst new file mode 100644 index 00000000000..5d5f147c88d --- /dev/null +++ b/source/Mirrors/Creating-your-own-ROS-mirror.rst @@ -0,0 +1,4 @@ +Creating Your Own ROS 2 Mirror +============================== + +TODO add some text. diff --git a/source/Mirrors/List-of-mirrors-and-their-usage.rst b/source/Mirrors/List-of-mirrors-and-their-usage.rst new file mode 100644 index 00000000000..b33f2e5fec6 --- /dev/null +++ b/source/Mirrors/List-of-mirrors-and-their-usage.rst @@ -0,0 +1,18 @@ +A List of ROS 2 Mirrors and How to Use Them +=========================================== + +TODO: A list. + + +.. csv-table:: ROS 2 Mirrors :rst:dir:`csv-table` + :header: "Country","Notes","Organization","Maintainer","URL" + + "🇨🇳 China","⋆","`University of XXX `_", "`Maintainer XXX `_","`http://mirrors.bfsu.edu.cn/ros/ `_ " + "🇨🇳 China","","`University of YYY `_", "`Maintainer YYY `_","`http://mirrors.bfsu.edu.cn/ros/ `_ " + "🇨🇳 China","†","`University of ZZZ `_", "`Maintainer ZZZ `_","`http://mirrors.bfsu.edu.cn/ros/ `_ " + + + + +- ⋆ - Only provides Ubuntu binaries. +- † - Only provides Windows binaries. diff --git a/source/Mirrors/Mirroring-ROS-documentation.rst b/source/Mirrors/Mirroring-ROS-documentation.rst new file mode 100644 index 00000000000..f675d5cd796 --- /dev/null +++ b/source/Mirrors/Mirroring-ROS-documentation.rst @@ -0,0 +1,5 @@ +Mirroring the ROS 2 Documentation +================================= + +TODO write some guidance. + diff --git a/source/index.rst b/source/index.rst index 5abb8d6af93..dd3f836336d 100644 --- a/source/index.rst +++ b/source/index.rst @@ -17,6 +17,7 @@ ROS 2 Documentation Concepts Contact The-ROS2-Project + Mirrors Package-Docs Related-Projects Glossary @@ -101,6 +102,28 @@ If you're interested in the advancement of the ROS 2 project: - Downloadable marketing materials - `Information about the ROS trademark `__ +Mirrors +------- + +Mirrors are secondary sources of ROS binaries that greatly speed up the process of installing ROS for users that reside far away from our main servers + +- A partial list of ROS mirrors and how to use them + + * :doc:`A list of mirrors and their usage. ` + +- If you already have a ROS 2 mirror and would like to add it to our list use this guide. + + * :doc:`Adding your mirror. ` + +- A brief guide to setting up your own mirror of ROS packages. + + * :doc:`Creating your own ROS mirror. ` + +- If you would like to mirror the ROS 2 documentation, and potentially translate it into your local language. + + * :doc:`Mirroring ROS Documentation. ` + + ROS community resources -----------------------