Skip to content

Commit

Permalink
fix: warning for relative links (#538)
Browse files Browse the repository at this point in the history
fix: fix relative links

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
  • Loading branch information
isamu-takagi authored Apr 23, 2024
1 parent 3c36fc2 commit 9cf4183
Show file tree
Hide file tree
Showing 26 changed files with 67 additions and 67 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ References:

The conversion relationship between every sensor coordinate system and `base_link` can be obtained through sensor calibration technology.
Please consult the following link
[calibrating your sensors](../../../how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors) for instructions
[calibrating your sensors](../../../how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors/index.md) for instructions
on how to calibrate your sensors.

2. Localization
Expand Down
8 changes: 4 additions & 4 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ If you believe that someone in the community has violated the Code of Conduct, p

To gain a high-level understanding of Autoware's architecture and design, the following pages provide a brief overview:

- [Autoware architecture](../design/)
- [Autoware concepts](../design/autoware-concepts/)
- [Autoware architecture](../design/index.md)
- [Autoware concepts](../design/autoware-concepts/index.md)

For experienced developers, the [Autoware interfaces](../design/autoware-interfaces/) and [individual component pages](../design/autoware-interfaces/components/) should also be reviewed to understand the inputs and outputs for each component or module at a more detailed level.
For experienced developers, the [Autoware interfaces](../design/autoware-interfaces/index.md) and [individual component pages](../design/autoware-interfaces/components/index.md) should also be reviewed to understand the inputs and outputs for each component or module at a more detailed level.

### Contributing to open source projects

If you are new to open source projects, we recommend reading GitHub's [How to Contribute to Open Source guide](https://opensource.guide/how-to-contribute/) for an overview of why people contribute to open source projects, what it means to contribute and much more besides.
If you are new to open source projects, we recommend reading GitHub's [How to Contribute to Open Source guide](https://opensource.guide/how-to-contribute) for an overview of why people contribute to open source projects, what it means to contribute and much more besides.

## How can I get help?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Autoware Core carries over the original policy of Autoware.Auto to be a stable a
- Code quality requirements for Universe are more relaxed to make it easier for new developers, students and researchers to contribute, but will still be stricter than the requirements for Autoware.AI.
- Any advanced features added to Universe that are useful to the wider Autoware community will be reviewed and considered for potential inclusion in the main Autoware Core codebase.

This way, the primary requirement of having a stable and safe autonomous driving system can be achieved, whilst simultaneously enabling access to state-of-the-art features created by third-party contributors. For more details about the design of Autoware Core/Universe, refer to the [Autoware concepts documentation page](../autoware-concepts/).
This way, the primary requirement of having a stable and safe autonomous driving system can be achieved, whilst simultaneously enabling access to state-of-the-art features created by third-party contributors. For more details about the design of Autoware Core/Universe, refer to the [Autoware concepts documentation page](../autoware-concepts/index.md).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vehicle Interface

This page describes the Vehicle Interface Component. Please refer to the [Vehicle Interface design document](../../autoware-architecture/vehicle/) for high-level concepts and data flow.
This page describes the Vehicle Interface Component. Please refer to the [Vehicle Interface design document](../../autoware-architecture/vehicle/index.md) for high-level concepts and data flow.

![Vehicle interface diagram](images/vehicle-interface.drawio.svg)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

{%- if uses %}
{%- for name in uses %}
- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name) }}
- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name + '.md') }}
{%- endfor %}
{%- else %}
- None
Expand All @@ -19,7 +19,7 @@

{%- if used %}
{%- for name in used %}
- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name) }}
- {{ create_relative_link(name, 'design/autoware-interfaces/ad-api/types/' + name + '.md') }}
{%- endfor %}
{%- else %}
- None
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Latest Version: {{ status }}
- Method: {{ method }}
- Data Type: {{ create_relative_link(type.name, 'design/autoware-interfaces/ad-api/types/' + type.name) }}
- Data Type: {{ create_relative_link(type.name, 'design/autoware-interfaces/ad-api/types/' + type.name + '.md') }}

## Description

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ please check the [official guide](https://docs.web.auto/en/user-manuals/vector-m

You can follow these pages for creating a Lanelet2 map and understanding its regulatory elements.

- [Lanelet2](./lanelet2)
- [Crosswalk](./crosswalk)
- [Stop Line](./stop-line)
- [Traffic Light](./traffic-light)
- [Speed Bump](./speed-bump)
- [Detection Area](./detection-area)
- [Lanelet2](./lanelet2/index.md)
- [Crosswalk](./crosswalk/index.md)
- [Stop Line](./stop-line/index.md)
- [Traffic Light](./traffic-light/index.md)
- [Speed Bump](./speed-bump/index.md)
- [Detection Area](./detection-area/index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
At this page, we will explain how to create a simple lanelet on your point cloud map.
If you didn't have a point cloud map before,
please check
and follow the steps on the [LIO-SAM mapping page](../../open-source-slam/lio-sam)
and follow the steps on the [LIO-SAM mapping page](../../open-source-slam/lio-sam/index.md)
for how to create a point cloud map for Autoware.

## Creating a Lanelet2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Here is the video for demonstration of LIO-SAM mapping in our campus environment
The output map format is local UTM,
we will change local UTM map to MGRS format for tutorial_vehicle.
Also, if you want change UTM to MGRS for autoware,
please follow [convert-utm-to-mgrs-map](../../converting-utm-to-mgrs-map) page.
please follow [convert-utm-to-mgrs-map](../../converting-utm-to-mgrs-map/index.md) page.

## Example Result

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ we will modify `extrinsic_calibration_package` for our sensor kit.
For tutorial_vehicle,
completed launch files when created following tutorial sections can be found [here](https://github.com/leo-drive/calibration_tools_tutorial_vehicle/tree/tutorial_vehicle/sensor/extrinsic_calibration_manager/launch/tutorial_vehicle_sensor_kit).

- [Manual Calibration](../extrinsic-manual-calibration)
- [Lidar-Lidar Calibration](../lidar-lidar-calibration)
- [Ground Plane-Lidar Calibration](../ground-lidar-calibration)
- [Intrinsic Camera Calibration](../intrinsic-camera-calibration)
- [Lidar-Camera Calibration](../lidar-camera-calibration)
- [Lidar-Imu Calibration](../lidar-imu-calibration)
- [Manual Calibration](../extrinsic-manual-calibration/index.md)
- [Lidar-Lidar Calibration](../lidar-lidar-calibration/index.md)
- [Ground Plane-Lidar Calibration](../ground-lidar-calibration/index.md)
- [Intrinsic Camera Calibration](../intrinsic-camera-calibration/index.md)
- [Lidar-Camera Calibration](../lidar-camera-calibration/index.md)
- [Lidar-Imu Calibration](../lidar-imu-calibration/index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ in a way that aligns the points
corresponding to the ground within the point cloud with the XY plane of the base_link.
This means that only the z, roll, and pitch values of the tf undergo calibration,
while the remaining x, y, and yaw values must be calibrated using other methods,
such as [manual adjustment](../extrinsic-manual-calibration) or [mapping-based lidar-lidar calibration](../lidar-camera-calibration).
such as [manual adjustment](../extrinsic-manual-calibration/index.md) or [mapping-based lidar-lidar calibration](../lidar-camera-calibration/index.md).

You need to apply this calibration method to each lidar separately,
so our bag should contain all lidars to be calibrated.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ or as tf launch files.
In this documentation,
we will explain TIER IV's [CalibrationTools](https://github.com/tier4/CalibrationTools) repository for the calibration process.
Please look
at [Starting with TIER IV's CalibrationTools page](./calibration-tools) for installation and usage of this tool.
at [Starting with TIER IV's CalibrationTools page](./calibration-tools/index.md) for installation and usage of this tool.

If you want to look at other calibration packages and methods, you can check out the following packages.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ another [Lidar-Camera calibration method](https://github.com/tier4/CalibrationTo

!!! warning

You need to apply [intrinsic calibration](../intrinsic-camera-calibration) before starting lidar-camera extrinsic calibration process. Also,
please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration) section.
You need to apply [intrinsic calibration](../intrinsic-camera-calibration/index.md) before starting lidar-camera extrinsic calibration process. Also,
please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration/index.md) section.
This is crucial for obtaining accurate results from this tool.
We will utilize the initial calibration parameters that were calculated
in the previous step of this tutorial.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ CalibrationTools.

!!! warning

Please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration) section.
Please obtain the initial calibration results from the [Manual Calibration](../extrinsic-manual-calibration/index.md) section.
This is crucial for obtaining accurate results from this tool.
We will utilize the initial calibration parameters that were calculated
in the previous step of this tutorial.
Expand Down Expand Up @@ -383,7 +383,7 @@ After the calibration is completed, then you should rviz2 screen like the image

![mapping-based-calibration-result](images/mapping-based-calibration-result.png)

The red points indicate pointcloud that initial calibration results of [previous section](../extrinsic-manual-calibration).
The red points indicate pointcloud that initial calibration results of [previous section](../extrinsic-manual-calibration/index.md).
The green points indicate aligned point (calibration result).
The calibration results will be saved automatically on your
`dst_yaml` ($HOME/sensor_kit_calibration.yaml) at this tutorial.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Now, we will modify these files according to our sensor design.
This file defines the mounting positions and orientations of sensors with `sensor_kit_base_link` as the parent frame.
We can assume `sensor_kit_base_link` frame is bottom of your main Lidar sensor.
We must create this file with euler format as [x, y, z, roll, pitch, yaw].
Also, we will set these values with "0" until the [calibration steps](../calibrating-sensors).
Also, we will set these values with "0" until the [calibration steps](../calibrating-sensors/index.md).

We will define new frames for this file, and we will connect them `.xacro` files.
We recommend naming as if your lidar sensor frame as "velodyne_top",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --package

If your vehicle interface is ready,
then you can add your vehicle_interface launch file in `vehicle_interface.launch.xml`.
Please check the [creating vehicle interface](../../creating-vehicle-interface-package/creating-a-vehicle-interface-for-an-ackermann-kinematic-model.md) page for more info.
Please check the [creating vehicle interface](../../creating-vehicle-interface-package/creating-vehicle-interface.md) page for more info.

### Launch planning simulator with your own vehicle

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
- `<YOUR_VEHICLE_NAME>_sensor_kit_description`
- `<YOUR_VEHICLE_NAME>_sensor_kit_launch`

Please refer to the [creating sensor model](./creating-sensor-model) page
Please refer to the [creating sensor model](./creating-sensor-model/index.md) page
for creating your individual sensor model.

For reference,
Expand All @@ -49,7 +49,7 @@ sample_sensor_kit_launch/
- `<YOUR_VEHICLE_NAME>_vehicle_description`
- `<YOUR_VEHICLE_NAME>_vehicle_launch`

Please consult the [creating vehicle model](./creating-vehicle-model) page
Please consult the [creating vehicle model](./creating-vehicle-model/index.md) page
for creating your individual vehicle model.

As a reference,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ After you implement your vehicle interface, or you want to debug it by launching
create a launch file of your vehicle interface,
and include it to `vehicle_interface.launch.xml` which included in `<VEHICLE_ID>_vehicle_launch` package
that we forked and created
at [creating vehicle and sensor description page](../creating-vehicle-and-sensor-description/creating-vehicle-and-sensor-description.md).
at [creating vehicle and sensor model page](../creating-vehicle-and-sensor-model/index.md).

Do not get confused. First, you need to create a launch file for your own vehicle interface module (like `my_vehicle_interface.launch.xml`) **and then include that to `vehicle_interface.launch.xml` which exists in another directory.** Here are the details.

Expand Down
20 changes: 10 additions & 10 deletions docs/how-to-guides/integrating-autoware/launch-autoware/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
This section explains how to run your vehicle with Autoware.
We will explain how to run and launch autoware with these modules:

- [Vehicle](./vehicle)
- [System](./system)
- [Map](./map)
- [Sensing](./sensing)
- [Localization](./localization)
- [Perception](./perception)
- [Planning](./planning)
- [Control](./control)
- [Vehicle](./vehicle/index.md)
- [System](./system/index.md)
- [Map](./map/index.md)
- [Sensing](./sensing/index.md)
- [Localization](./localization/index.md)
- [Perception](./perception/index.md)
- [Planning](./planning/index.md)
- [Control](./control/index.md)

## Pre-requirements of launching Autoware with real vehicle

Expand All @@ -20,7 +20,7 @@ Please complete these steps for integration Autoware on your vehicle:
- [Create your vehicle and sensor model](../creating-vehicle-and-sensor-model/index.md).
- [Calibrate your sensors](../creating-vehicle-and-sensor-model/calibrating-sensors/index.md).
- [Create your Autoware compatible vehicle interface](../creating-vehicle-interface-package/vehicle-interface.md).
- [Create your environment map](../creating-maps).
- [Create your environment map](../creating-maps/index.md).

After the completion of these steps according to your individual vehicle,
you are ready to use Autoware.
Expand Down Expand Up @@ -170,7 +170,7 @@ If you don't want to use traffic light classifier, then you can disable it:
+ <arg name="traffic_light_recognition/enable_fine_detection" default="false" description="enable traffic light fine detection"/>
```

Please look at [Launch perception](./perception) page for detailed information.
Please look at [Launch perception](./perception/index.md) page for detailed information.

## Launch Autoware

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The current localization launcher implemented by TIER IV supports multiple local
You can use YabLoc as a camera-based localization method.
For more details on YabLoc,
please refer to the [README of YabLoc](https://github.com/autowarefoundation/autoware.universe/blob/main/localization/yabloc/README.md) in autoware.universe.
Also, you can use Eagleye as a GNSS & IMU & wheel odometry-based localization method. For more details on Eagleye, please refer to the [Eagleye](./eagleye).
Also, you can use Eagleye as a GNSS & IMU & wheel odometry-based localization method. For more details on Eagleye, please refer to the [Eagleye](./eagleye/index.md).

You can set `pose_source` argument on `tier4_localization_component.launch.xml`,
for example, if you want to use eagleye as pose_source,
Expand All @@ -60,7 +60,7 @@ The current localization launcher implemented by TIER IV supports multiple local
- **`twist_source:`** This argument specifies the twist_estimator, currently supporting `gyro_odom` (default), and `eagleye`.
By default,
Autoware launches [gyro_odometer](https://github.com/autowarefoundation/autoware.universe/tree/main/localization/gyro_odometer) for twist estimator.
Also, you can use eagleye for the twist source, please refer to the [Eagleye](./eagleye).
Also, you can use eagleye for the twist source, please refer to the [Eagleye](./eagleye/index.md).
If you want to change your twist source to eagleye, you can update `tier4_localization_component.launch.xml` like:

```diff
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-guides/integrating-autoware/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Create `launch/sensing.launch.xml` that launches the interfaces of all the senso
!!! note

At this point, you are now able to run Autoware's Planning Simulator to do a basic test of your vehicle and sensing packages.
To do so, you need to build and install Autoware using your cloned repository. Follow the [steps for either Docker or source installation](../installation/) (starting from the dependency installation step) and then run the following command:
To do so, you need to build and install Autoware using your cloned repository. Follow the [steps for either Docker or source installation](../../installation/index.md) (starting from the dependency installation step) and then run the following command:

```bash
ros2 launch autoware_launch planning_simulator.launch.xml vehicle_model:=YOUR_VEHICLE sensor_kit:=YOUR_SENSOR_KIT map_path:=/PATH/TO/YOUR/MAP
Expand Down Expand Up @@ -120,7 +120,7 @@ This section briefly explains how to run your vehicle with Autoware.

### Install Autoware

Follow the [installation steps of Autoware](../../installation/).
Follow the [installation steps of Autoware](../../installation/index.md).

### Launch Autoware

Expand Down
Loading

0 comments on commit 9cf4183

Please sign in to comment.