Skip to content

Draft Mirror Information #5223

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

Draft
wants to merge 2 commits into
base: rolling
Choose a base branch
from
Draft
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
14 changes: 14 additions & 0 deletions source/Mirrors.rst
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions source/Mirrors/Adding-your-mirror.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Adding Your ROS 2 Mirror
========================

Add more text here.
4 changes: 4 additions & 0 deletions source/Mirrors/Creating-your-own-ROS-mirror.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Creating Your Own ROS 2 Mirror
==============================

TODO add some text.
18 changes: 18 additions & 0 deletions source/Mirrors/List-of-mirrors-and-their-usage.rst
Original file line number Diff line number Diff line change
@@ -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 <http://www.xxx.edu>`_", "`Maintainer XXX <mailto:[email protected]>`_","`http://mirrors.bfsu.edu.cn/ros/ <http://mirrors.bfsu.edu.cn/ros/>`_ "
"🇨🇳 China","","`University of YYY <http://www.yyy.edu>`_", "`Maintainer YYY <mailto:[email protected]>`_","`http://mirrors.bfsu.edu.cn/ros/ <http://mirrors.bfsu.edu.cn/ros/>`_ "
"🇨🇳 China","†","`University of ZZZ <http://www.zzz.edu>`_", "`Maintainer ZZZ <mailto:[email protected]>`_","`http://mirrors.bfsu.edu.cn/ros/ <http://mirrors.bfsu.edu.cn/ros/>`_ "




- ⋆ - Only provides Ubuntu binaries.
- † - Only provides Windows binaries.
5 changes: 5 additions & 0 deletions source/Mirrors/Mirroring-ROS-documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Mirroring the ROS 2 Documentation
=================================

TODO write some guidance.

23 changes: 23 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ROS 2 Documentation
Concepts
Contact
The-ROS2-Project
Mirrors
Package-Docs
Related-Projects
Glossary
Expand Down Expand Up @@ -101,6 +102,28 @@ If you're interested in the advancement of the ROS 2 project:
- Downloadable marketing materials
- `Information about the ROS trademark <https://www.ros.org/blog/media/>`__

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. <Mirrors/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. <Mirrors/Adding-your-mirror>`

- A brief guide to setting up your own mirror of ROS packages.

* :doc:`Creating your own ROS mirror. <Mirrors/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. <Mirrors/Mirroring-ROS-documentation>`


ROS community resources
-----------------------

Expand Down
Loading