Merge pull request #32 from tlab-wide/update-docs

Update Documentation
This commit is contained in:
Yu Asabe 2022-12-21 14:22:03 +09:00 committed by GitHub
commit 67d7b8fbf4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 2 deletions

41
.github/workflows/deploy-docs.yaml vendored Normal file
View File

@ -0,0 +1,41 @@
name: deploy-docs
on:
push:
branches:
- main
paths:
- mkdocs.yaml
- "**/*.md"
- "**/*.svg"
- "**/*.png"
- "**/*.jpg"
pull_request_target:
types:
- opened
- synchronize
- labeled
workflow_dispatch:
jobs:
prevent-no-label-execution:
uses: autowarefoundation/autoware-github-actions/.github/workflows/prevent-no-label-execution.yaml@v1
with:
label: deploy-docs
deploy-docs:
needs: prevent-no-label-execution
if: ${{ needs.prevent-no-label-execution.outputs.run == 'true' }}
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}
- name: Deploy docs
uses: autowarefoundation/autoware-github-actions/deploy-docs@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
latest: ${{ github.event_name != 'pull_request_target' && github.ref_name == github.event.repository.default_branch }}

View File

@ -9,17 +9,26 @@ In order to run the simulations explained in the [Tutorials](/tutorials) section
For the newest documentation for the Docker installation of Autoware, see their [official documentation](https://autowarefoundation.github.io/autoware-documentation/main/installation/autoware/docker-installation/). For the newest documentation for the Docker installation of Autoware, see their [official documentation](https://autowarefoundation.github.io/autoware-documentation/main/installation/autoware/docker-installation/).
### Prerequisites
- git
### Setup ### Setup
1. Prepare the repository.
```bash ```bash
mkdir -p ~/workspace && cd ~/workspace mkdir -p ~/workspace && cd ~/workspace
git clone https://github.com/autowarefoundation/autoware.git autoware_docker git clone https://github.com/autowarefoundation/autoware.git autoware_docker
cd autoware_docker cd autoware_docker
```
# Install dependencies using Ansible 2. Run the setup script for docker installation.
```
./setup-dev-env.sh docker ./setup-dev-env.sh docker
```
You will need to restart your PC after the script is finished running.
# Make directory to store maps 3. Make directory to store maps
```
mkdir -p ~/data/maps mkdir -p ~/data/maps
``` ```