Skip to content

Commit

Permalink
docs(installation): update installation pages (autowarefoundation#104)
Browse files Browse the repository at this point in the history
* docs: rename developper settings

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* ci(pre-commit): autofix

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix: link

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* docs(autoware-interfaces): add autoware interface design (autowarefoundation#69)

* docs(autoware-interfaces): add autoware interface design

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>

* docs(autoware-interfaces): remove version from api name

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>

* docs(autoware-interfaces): mention the local interface

Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix: url

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* fix: rm duplication

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: rm old ref

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: edit name

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: lead to support

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* rm duplication

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* ci(pre-commit): autofix

* chore: fix wording

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: fix link

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

* chore: rename

Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Takagi, Isamu <43976882+isamu-takagi@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Co-authored-by: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com>
Signed-off-by: Shark Liu <huiyuan.liu@autocore.ai>
  • Loading branch information
5 people authored and Shark Liu committed Jun 7, 2022
1 parent 13cf906 commit 4a463a5
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 32 deletions.
4 changes: 2 additions & 2 deletions docs/installation/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nav:
- index.md
- autoware
- tools-for-users
- tools-for-developers
- related-tools
- additional-settings-for-developers
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation of tools for developers
# Additional settings for developers

## ROS 2 settings

Expand Down
1 change: 0 additions & 1 deletion docs/installation/autoware/.pages
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
nav:
- index.md
- docker-installation.md
- source-installation.md
20 changes: 0 additions & 20 deletions docs/installation/autoware/index.md

This file was deleted.

31 changes: 24 additions & 7 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,36 @@ The Autoware Foundation provides no support on other platforms than those listed

Refer to [REP-2000](https://www.ros.org/reps/rep-2000.html) for the system dependencies.

## Installation steps of Autoware
## Installing Autoware

See [here](autoware) for how to install Autoware.
There are two ways to set up Autoware. Choose one according to your preference.

## Installation steps of tools for users
If any issues occur during installation, refer to the [Support page](https://autowarefoundation.github.io/autoware-documentation/main/support).

### 1. Docker installation

Docker can ensure that all developers in a project have a common, consistent development environment.
It is recommended for beginners, casual users, people who are unfamiliar with Ubuntu.

Refer to the [Docker installation guide](autoware/docker-installation.md) for detailed steps.

### 2. Source installation

Source installation is for the cases where more granular control of the installation environment is needed.
It is recommended for experienced users or people who want to customize their environment.
Note that some problems may occur depending on your local environment.

Refer to the [source installation guide](autoware/source-installation.md) for detailed steps.

## Installing related tools

Some other tools are required depending on the evaluation you want to do.
For example, if you run E2E simulation, you need to install a simulator for that.
For example, to run an end-to-end simulation you need to install an appropriate simulator.

See [here](tools-for-users) for how to install the tools.
See [here](related-tools) for how to install the tools.

## Installation steps of tools for developers
## Additional settings for developers

There are also tools and settings for developers, such as Shells or IDEs.

See [here](tools-for-developers) for how to install the tools.
See [here](additional-settings-for-developers) for how to install the tools.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation of tools for users
# Installation of related tools

!!! warning

Expand Down

0 comments on commit 4a463a5

Please sign in to comment.