added outdated warnings

ctu-mrs · Oct 8, 2023 · 350768b · 350768b
1 parent 81ef7dc
commit 350768b
Show file tree

Hide file tree

Showing 29 changed files with 108 additions and 88 deletions.
diff --git a/docs/hardware/motor_tests.md b/docs/hardware/motor_tests.md
@@ -4,6 +4,10 @@ title: Motor tests
 parent: Hardware
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Motor tests
 All motor tests are done with a Turnigy MultiStar BLheli_32 51A ESC, with the 32.7 BLheli firmware. [ESC config](https://github.com/ctu-mrs/uav_core/blob/master/miscellaneous/blheli32_esc_config/T650/T650_M1.ini) is available in our repository. 
 Current and voltage measurements are done by the ESC and thrust is measured with a 5 kg load cell, coupled with a HX711 amplifier.

diff --git a/docs/hardware/post_installation.md b/docs/hardware/post_installation.md
@@ -4,6 +4,10 @@ title: Post installation guide
 parent: Hardware
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Linux SWAP size increase
 
 TODO

diff --git a/docs/hardware/px4_configuration.md b/docs/hardware/px4_configuration.md
@@ -4,6 +4,10 @@ title: PX4 Configuration
 parent: Hardware
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Pixhawk setup on a new drone
 Follow this guide to setup a new drone with the Pixhawk autopilot for the MRS UAV system.
 

diff --git a/docs/introduction/how_to_compile.md b/docs/introduction/how_to_compile.md
@@ -5,6 +5,10 @@ parent: Introduction
 nav_order: 99
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 We use [catkin tools](https://catkin-tools.readthedocs.io/en/latest/) to manage our ROS workspaces.
 Make sure you are located within the workspace when issuing the following commands.
 If your workspace is sourced, you can `cd` to the workspace by:

diff --git a/docs/introduction/how_to_update.md b/docs/introduction/how_to_update.md
@@ -5,6 +5,10 @@ parent: Introduction
 nav_order: 98
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # How to update the mrs_uav_system
 
 This manual assumes you have already installed the [mrs_uav_system](https://github.com/ctu-mrs/mrs_uav_system) and you want to update package(s) of the MRS system.

diff --git a/docs/introduction/suggested_reading.md b/docs/introduction/suggested_reading.md
@@ -5,6 +5,10 @@ parent: Introduction
 nav_order: 1
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Mandatory readings for newcomers
 
 Nowadays, doing research in this field is not just about the theory and occasional lab experiment.

diff --git a/docs/simulation/custom_world.md b/docs/simulation/custom_world.md
@@ -5,6 +5,10 @@ parent: Simulation
 nav_order: 3
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # How to start the simulation with a custom world
 
 ![](fig/custom_world.jpg)

diff --git a/docs/simulation/drone_spawner.md b/docs/simulation/drone_spawner.md
@@ -5,6 +5,10 @@ parent: Simulation
 nav_order: 2
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # About
 
 The `mrs_drone_spawner` is a ROS node written in Python, which allows you to dynamically add drones into your Gazebo simulation.

diff --git a/docs/simulation/howto.md b/docs/simulation/howto.md
@@ -5,6 +5,10 @@ parent: Simulation
 nav_order: 1
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # How to start the simulation
 If you have everything installed and compiled, the next step is to test it in the simulation.
 Running the simulation consists of several steps, which are usually **automated** using a **tmuxinator** script.

diff --git a/docs/simulation/simulation_motor_thrust.md b/docs/simulation/simulation_motor_thrust.md
@@ -5,6 +5,10 @@ parent: Simulation
 nav_order: 6
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Gazebo Motor parameters
 
 * **Pixhawk** controller output is shaped via function

diff --git a/docs/simulation/simulation_speed.md b/docs/simulation/simulation_speed.md
@@ -5,6 +5,10 @@ parent: Simulation
 nav_order: 4
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Run Simulation Faster than Real-time
 
 Simulation In The Loop (SITL) can be run faster or slower than real-time.

diff --git a/docs/software/catkin/managing_workspaces/managing_workspaces.md b/docs/software/catkin/managing_workspaces/managing_workspaces.md
@@ -5,6 +5,10 @@ parent: catkin
 grand_parent: Software
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Managing Workspaces
 
 This guide is an important and mandatory reading for all MRS members.

diff --git a/docs/software/gdb.md b/docs/software/gdb.md
@@ -4,6 +4,10 @@ title: Debugging with GDB
 parent: Software
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Debugging with GDB
 
 If you're experiencing crashes of your C/C++ ROS node/nodelet or if your program is not behaving as expected in general and you want to inspect it, you can reach for a debugger.

diff --git a/docs/software/gitman.md b/docs/software/gitman.md
@@ -4,6 +4,10 @@ title: Gitman
 parent: Software
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Gitman "submodule" manager
 
 Gitman, a git project manager, is a program for resolving dependency between multiple git repositories.

diff --git a/docs/software/hector_slam.md b/docs/software/hector_slam.md
@@ -4,6 +4,10 @@ title: Hector SLAM
 parent: Software
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Hector SLAM
 
 Hector slam ([github.com/tu-darmstadt-ros-pkg/hector_slam](http://github.com/tu-darmstadt-ros-pkg/hector_slam)) is a 2D LIDAR SLAM.

diff --git a/docs/software/known_issues.md b/docs/software/known_issues.md
@@ -4,6 +4,10 @@ title: Known Issues
 parent: Software
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 ## RTK Frame Issue
 
 It has been noted at times that the UAV could find itself under the safety area's minimum-Z height specified. If a tmux flight session is started on the UAV before the RTK fix is fully acquired, it sets its local origin at this start time and can then end up finding itself below ground height even when it is using the height sensor. This issue will show up in trajectory reference as "Start point / pose of the trajectory is outside the safety area".

diff --git a/docs/software/mavros.md b/docs/software/mavros.md
@@ -5,6 +5,10 @@ parent: Software
 nav_order: 97
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Mavros
 
 [Mavros](https://github.com/mavlink/mavros) provides an interface between the [uav_core](https://github.com/ctu-mrs/uav_core) and the [Pixhawk](https://pixhawk.org/) flight controller.

diff --git a/docs/software/mrs_utils.md b/docs/software/mrs_utils.md
@@ -5,6 +5,10 @@ parent: Software
 nav_order: 99
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # MRS Utilities
 
 MRS Utilities contains various useful tools for development and testing.

diff --git a/docs/software/ros_remote.md b/docs/software/ros_remote.md
@@ -4,6 +4,10 @@ title: ROS remote
 parent: Software
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Connecting to ROS core remotely
 
 ROS allows multiple computers to communicate and share topics and services via a local network.

diff --git a/docs/system/bashrc_configuration.md b/docs/system/bashrc_configuration.md
@@ -5,6 +5,10 @@ parent: The UAV system
 nav_order: 5
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # What is .basrc?:
 
 You can find the `.bashrc` file in the home folder of the UAV's onboard computer, it is a hidden file.

diff --git a/docs/system/custom_configs.md b/docs/system/custom_configs.md
@@ -5,6 +5,10 @@ parent: The UAV system
 nav_order: 6
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # How to use custom config files for uav_core modules
 
 ## Motivation

diff --git a/docs/system/flying_without_mrs_odom.md b/docs/system/flying_without_mrs_odom.md
diff --git a/docs/system/frames_of_reference.md b/docs/system/frames_of_reference.md
@@ -5,6 +5,10 @@ parent: The UAV system
 nav_order: 1
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Frames of Reference
 
 As described in the [Transformations](transformations.md) manual, the MRS control system enables to send commands to a UAV in all coordinate frames for which a transformation to the control frame exists.

diff --git a/docs/system/preparing_for_a_real-world_experiment.md b/docs/system/preparing_for_a_real-world_experiment.md
@@ -5,6 +5,10 @@ parent: The UAV system
 nav_order: 7
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 # Preparing for a real-world experiment:
 
 This guide is intended for newcomers to the MRS group who are planning a real-world experiment, and it is therefore specific to the UAV platforms and setup used by the MRS group. But all the ideas are also applicable to other people.

diff --git a/docs/system/relative_commands.md b/docs/system/relative_commands.md
@@ -5,6 +5,10 @@ parent: The UAV system
 nav_order: 9
 ---
 
+| :warning: **Attention please: This page is outdated.**                                                                                           |
+| :---                                                                                                                                             |
+| The MRS UAV System 1.5 is being released and this page needs updating. Plase, keep in mind that the information on this page might not ve valid. |
+
 ## tl;dr:
 If you're setting a setpoint reference relative to the current UAV pose, do not use the pose from the [state estimator](https://github.com/ctu-mrs/mrs_uav_odometry) to calculate the new setpoint.
 Use the UAV pose from the "commanded pose" topic (currently named `control_manager/position_cmd`) to avoid drift.