Skip to content

Commit 9a828e7

Browse files
isamu-takagikminodapre-commit-ci[bot]
authored
feat: add interface list page (#42)
* add interface list page Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * Update docs/design/autoware-interfaces/components/interfaces.md Co-authored-by: kminoda <44218668+kminoda@users.noreply.github.com> * style(pre-commit): autofix --------- Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> Co-authored-by: kminoda <44218668+kminoda@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent bfed35d commit 9a828e7

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/design/autoware-interfaces/components/.pages

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
nav:
22
- index.md
3+
- interfaces.md
34
- planning.md
45
- control.md
56
- localization.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Interfaces
2+
3+
## Overview
4+
5+
インターフェース変更により意図せずAutowareや周辺ツールが動かなくなってしまうのを防ぐため、下記の条件に該当するインターフェースを更新する際は slack にて通知を行い、関係者と対応方針を相談してください。
6+
7+
- [autoware_msgs](https://github.com/autowarefoundation/autoware_msgs)[autoware_auto_msgs](https://github.com/tier4/autoware_auto_msgs) に依存するインターフェース
8+
- このページに記載されたインターフェース
9+
10+
内部で使用される [tier4_autoware_msgs](https://github.com/tier4/tier4_autoware_msgs) などのインターフェースに依存がある場合、通知の必要性を明示するため、このページにインターフェースを追加する PR を作成してください。インターフェースの提供者はレビューを行い、そのインターフェースを外部から使用して問題ないか判断してください。
11+
12+
- 公開インターフェースは [autoware_msgs](https://github.com/autowarefoundation/autoware_msgs) に配置するのが望ましいため、適宜移行してください。
13+
- 逆に非公開のインターフェースは [autoware_msgs](https://github.com/autowarefoundation/autoware_msgs)[autoware_auto_msgs](https://github.com/tier4/autoware_auto_msgs) に配置しないでください。
14+
15+
## Topics and services
16+
17+
| Name | Description |
18+
| ---- | ----------- |
19+
20+
## System files
21+
22+
| Path | Description |
23+
| ---------------------------- | -------------------- |
24+
| lanelet2_map.osm | レーンレット |
25+
| pointcloud_map.pcd | 点群地図 |
26+
| pointcloud_map_metadata.yaml | 点群地図のメタデータ |
27+
| map_projector_info.yaml | 地図の射影情報 |
28+
29+
## Parameter files
30+
31+
| Path | Description |
32+
| ---- | ----------- |

0 commit comments

Comments
 (0)