Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(installation): add minimum hardware requirements #137

Merged
merged 39 commits into from
Jun 7, 2022
Merged

docs(installation): add minimum hardware requirements #137

merged 39 commits into from
Jun 7, 2022

Conversation

Sharrrrk
Copy link
Contributor

@Sharrrrk Sharrrrk commented Jun 6, 2022 •
edited by kenji-miyake
Loading

Description

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@Sharrrrk Sharrrrk requested a review from kenji-miyake June 6, 2022 09:14
@kenji-miyake kenji-miyake requested a review from a user June 6, 2022 09:39
@Sharrrrk Sharrrrk requested a review from kenji-miyake June 7, 2022 02:50
ghost
ghost reviewed Jun 7, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review done. Please let me know if you have any comments or feedback.

docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
docs/installation/index.md Outdated Show resolved Hide resolved
@Sharrrrk
Copy link
Contributor Author

Sharrrrk commented Jun 7, 2022

Review done. Please let me know if you have any comments or feedback.

Thank you very much. Very good suggestions, already updated.

@ghost ghost self-requested a review June 7, 2022 07:06
ghost
ghost previously approved these changes Jun 7, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Lalith Vipulananthan and others added 20 commits June 7, 2022 15:10
@pre-commit-ci @kenji-miyake
docs: update troubleshooting guide (autowarefoundation#107)
13cf906 
* docs: update troubleshooting guide

Signed off by: Lalith Vipulananthan <[email protected]>

* ci(pre-commit): autofix

* Removed TOC and updated the setup section title

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <[email protected]>

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <[email protected]>

* Update docs/support/troubleshooting.md

Add swap configuration steps

Co-authored-by: Kenji Miyake <[email protected]>

* ci(pre-commit): autofix

* fix code blocks

Signed-off-by: Kenji Miyake <[email protected]>

* Create troubleshooting.md

Reworded the CUDA warning to specify the supported version, fixed the code block for the swap config steps and added the Digital Ocean link back in.

* ci(pre-commit): autofix

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <[email protected]>

* Update docs/support/troubleshooting.md

Co-authored-by: Kenji Miyake <[email protected]>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@shmpwk @pre-commit-ci
@isamu-takagi @kenji-miyake
docs(installation): update installation pages (autowarefoundation#104)
4a463a5 
* docs: rename developper settings

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* ci(pre-commit): autofix

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* fix: link

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* fix

Signed-off-by: Shumpei Wakabayashi <[email protected]>

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

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

Signed-off-by: Takagi, Isamu <[email protected]>

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

Signed-off-by: Takagi, Isamu <[email protected]>

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

Signed-off-by: Takagi, Isamu <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* fix: url

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* fix: rm duplication

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: rm old ref

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: edit name

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* Update docs/installation/index.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: lead to support

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* rm duplication

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* ci(pre-commit): autofix

* chore: fix wording

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: fix link

Signed-off-by: Shumpei Wakabayashi <[email protected]>

* chore: rename

Signed-off-by: Shumpei Wakabayashi <[email protected]>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Takagi, Isamu <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@isamu-takagi @kenji-miyake
fix(support): remove dead link (autowarefoundation#116)
084ec85 
* fix(support): remove dead link

Signed-off-by: Takagi, Isamu <[email protected]>

* Update docs/support/troubleshooting.md

Co-authored-by: Lalith Vipulananthan <[email protected]>

* Update troubleshooting.md

Co-authored-by: Kenji Miyake <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@kminoda
feat: add integrate autoware with your vehicle (autowarefoundation#109)
bc39603 
Signed-off-by: Shark Liu <[email protected]>
@awf-autoware-bot @kenji-miyake
chore: sync files (autowarefoundation#106)
f2e5e7f 
Signed-off-by: GitHub <[email protected]>

Co-authored-by: kenji-miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk
docs: fix dead link in how-to-guides (autowarefoundation#121)
9163cac 
Signed-off-by: Shark Liu <[email protected]>

Co-authored-by: Shark Liu <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk @pre-commit-ci @kenji-miyake
docs(installation): add arm64 docker installation (autowarefoundation…
882775d 
…#120)

* add arm64 docker installation

Signed-off-by: Shark Liu <[email protected]>

* ci(pre-commit): autofix

* docs: remove the -arm64 tag from image tag

Signed-off-by: Shark Liu <[email protected]>

* ci(pre-commit): autofix

* Update docs/installation/autoware/docker-installation.md

Co-authored-by: Kenji Miyake <[email protected]>

* Update docs/installation/autoware/docker-installation.md

Co-authored-by: Kenji Miyake <[email protected]>

Co-authored-by: Shark Liu <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@WJaworskiRobotec @pre-commit-ci @kenji-miyake
docs(tutorial): ss2 instructions (autowarefoundation#118)
0a83fc8 
* Update and rename rosbag-replay-simulation.md to Installation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Rename Installation.md to installation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update and rename digital-twin-simulation.md to scenario-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update and rename planning-simulation.md to random-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update and rename scenario-simulation.md to scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update .pages

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Add files via upload

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/random-test-simulation.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/scenario-test-simulation.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/random-test-simulation.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/scenario-test-simulation.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/random-test-simulation.md

Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* Create rosbag-replay-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Create digital-twin-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update .pages

Signed-off-by: Wojciech Jaworski <[email protected]>

* changed structure of files

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update installation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update installation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* ci(pre-commit): autofix

Signed-off-by: Wojciech Jaworski <[email protected]>

* fix .pages

Signed-off-by: Kenji Miyake <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* move images

Signed-off-by: Kenji Miyake <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* Update installation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update scenario-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update random-test-simulation.md

Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/planning-simulation/random-test-simulation.md

Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

* Update docs/tutorials/scenario-simulation/planning-simulation/scenario-test-simulation.md

Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Wojciech Jaworski <[email protected]>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Co-authored-by: Kenji Miyake <[email protected]>
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@pre-commit-ci
ci(pre-commit): autoupdate (autowarefoundation#122)
930e08c 
updates:
- [github.com/scop/pre-commit-shfmt: v3.4.3-1 → v3.5.0-1](scop/pre-commit-shfmt@v3.4.3-1...v3.5.0-1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Signed-off-by: Shark Liu <[email protected]>
@xmfcx
docs(components): add vehicle dimensions page (autowarefoundation#79)
9e925b4 
Signed-off-by: M. Fatih Cırıt <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@kenji-miyake
docs: replace "ROS2" with "ROS 2" (autowarefoundation#133)
946c33f 
* docs: replace "ROS2" with "ROS 2"

Signed-off-by: Kenji Miyake <[email protected]>

* fix invalid links

Signed-off-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
Perf: Add Ubuntu 2204 and ROS in prerequisites
564c0b8 
Signed-off-by: Shark Liu <[email protected]>
docs: add minimum hardware requirments
2d03d44 
Signed-off-by: Shark Liu <[email protected]>
docs(installation): fix styles
4901563 
Signed-off-by: Shark Liu <[email protected]>
@pre-commit-ci
ci(pre-commit): autofix
dbb35eb 
Signed-off-by: Shark Liu <[email protected]>
docs(installation): fix style
f5b0163 
Signed-off-by: Shark Liu <[email protected]>
docs(installation): fix typo
d8c0991 
Signed-off-by: Shark Liu <[email protected]>
@mitsudome-r @pre-commit-ci @kenji-miyake
docs(concepts): add explanation of Core/Universe from AI and Auto (au…
3b39808 
…towarefoundation#132)

* docs(concepts): add explanation of Core/Universe from AI and Auto

Signed-off-by: mitsudome-r <[email protected]>

* ci(pre-commit): autofix

* docs: fix from spell-check

Signed-off-by: mitsudome-r <[email protected]>

* docs: apply suggested change

Signed-off-by: mitsudome-r <[email protected]>

* ci(pre-commit): autofix

* Fix warning admonition code block

Signed-off-by: Lalith Vipulananthan <[email protected]>

Co-authored-by: Kenji Miyake <[email protected]>

* Fix bullet points in issues list

Co-authored-by: Kenji Miyake <[email protected]>

* Update description of Autoware.AI

Signed-off-by: Lalith Vipulananthan <[email protected]>

Co-authored-by: Kenji Miyake <[email protected]>

* Update description of issues with Autoware.AI development

Signed-off-by: Lalith Vipulananthan <[email protected]>

Co-authored-by: Kenji Miyake <[email protected]>

* ci(pre-commit): autofix

* Update Autoware.Auto descripiton to match Autoware.AI

Signed-off-by: Lalith Vipulananthan <[email protected]>

Co-authored-by: Kenji Miyake <[email protected]>

* Update Autoware.Auto description

Signed-off-by: Lalith Vipulananthan <[email protected]>

Co-authored-by: Kenji Miyake <[email protected]>

* docs(concepts): apply suggeted changes

Signed-off-by: mitsudome-r <[email protected]>

* ci(pre-commit): autofix

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@kminoda @pre-commit-ci
docs(how-to guides): add runninng Autoware without CUDA (autowarefoun…
e6a1b95 
…dation#128)

* added files

Signed-off-by: kminoda <[email protected]>

* ci(pre-commit): autofix

* reflected reviews

Signed-off-by: kminoda <[email protected]>

* ci(pre-commit): autofix

* added concrete configurations for object detection

Signed-off-by: kminoda <[email protected]>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Signed-off-by: Shark Liu <[email protected]>
@kminoda
docs(how-to guides): how to integrate differential drive vehicles (au…
2f26651 
…towarefoundation#125)

Signed-off-by: Shark Liu <[email protected]>
Sharrrrk and others added 11 commits June 7, 2022 15:10
@Sharrrrk
Update docs/installation/index.md
6a4db2c 
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@pre-commit-ci
ci(pre-commit): autofix
881cc7d 
Signed-off-by: Shark Liu <[email protected]>
Perf: Add Ubuntu 2204 and ROS in prerequisites
7e279b9 
Signed-off-by: Shark Liu <[email protected]>
@pre-commit-ci
ci(pre-commit): autofix
2bcafbf 
Signed-off-by: Shark Liu <[email protected]>
docs(installation): fix style
383950c 
Signed-off-by: Shark Liu <[email protected]>
docs(installation): fix typo
6fec9bb 
Signed-off-by: Shark Liu <[email protected]>
@kenji-miyake
docs: fix styles (autowarefoundation#139)
1aa083d 
Signed-off-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@pre-commit-ci
ci(pre-commit): autofix
17d720a 
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk
Update docs/installation/index.md
123bfb8 
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk
Update docs/installation/autoware/source-installation.md
d907f1f 
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@pre-commit-ci
ci(pre-commit): autofix
09016ab 
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk Sharrrrk dismissed ghost ’s stale review via 09016ab June 7, 2022 07:20
@Sharrrrk Sharrrrk force-pushed the 123-add-hardware-requirements branch from 856c762 to 09016ab Compare June 7, 2022 07:20
@kenji-miyake
Copy link
Contributor

@Sharrrrk Could you resolve conflicts?
image

@Sharrrrk Sharrrrk enabled auto-merge (squash) June 7, 2022 07:44
@Sharrrrk Sharrrrk requested a review from a user June 7, 2022 07:53
@Sharrrrk
Copy link
Contributor Author

Sharrrrk commented Jun 7, 2022

@Sharrrrk Could you resolve conflicts? image

Done.

@kenji-miyake kenji-miyake added the type:documentation Creating or refining documentation. label Jun 7, 2022
@github-actions
Copy link

github-actions bot commented Jun 7, 2022

Documentation URL: https://autowarefoundation.github.io/autoware-documentation/pr-137/
Modified URLs:

Sharrrrk and others added 2 commits June 7, 2022 16:29
@Sharrrrk @kenji-miyake
Update docs/installation/autoware/source-installation.md
a0a5423 
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk @kenji-miyake
Update docs/installation/index.md
7590183 
Co-authored-by: Kenji Miyake <[email protected]>
Signed-off-by: Shark Liu <[email protected]>
@Sharrrrk Sharrrrk force-pushed the 123-add-hardware-requirements branch from b5d9e6f to 7590183 Compare June 7, 2022 08:30
@Sharrrrk Sharrrrk requested a review from kenji-miyake June 7, 2022 09:41
kenji-miyake
kenji-miyake approved these changes Jun 7, 2022
View reviewed changes
Copy link
Contributor

@kenji-miyake kenji-miyake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Sharrrrk Sharrrrk merged commit 1347743 into autowarefoundation:main Jun 7, 2022
@tier4-autoware-public-bot tier4-autoware-public-bot bot mentioned this pull request Jun 8, 2022
Merged
@Sharrrrk Sharrrrk deleted the 123-add-hardware-requirements branch June 8, 2022 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kenji-miyake kenji-miyake kenji-miyake approved these changes

Assignees
No one assigned
Labels
type:documentation Creating or refining documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@Sharrrrk @kenji-miyake @shmpwk @isamu-takagi @kminoda @WJaworskiRobotec @xmfcx @mitsudome-r @TakaHoribe