docs: add installation steps #18
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 tasks
kenji-miyake
force-pushed
the
add-installation-steps
branch
3 times, most recently
from
cfa4963
to
f1ed781
Compare
[#534] Adding specific troubleshooting steps to ade installation page. Minor reorg of installation doc. Resolve "Remove Atom from ADE" Adding instructions for switching DDS vendors. Resolve "Add Documentation to Installation Guide Regarding disabling NVidia GPUs" Squashed 'src/external/autoware_auto_msgs/' changes from 56550efd..f40970ea f40970ea Adding velocity_mps to VehicleControlCommand. git-subtree-dir: src/external/autoware_auto_msgs git-subtree-split: f40970ead34d36a695b432dc37accff9d67c17e2 Revert "Resolve "Apply Node Composition Using `rclcpp_components` to All Nodes" - pure_pursuit_nodes" This reverts commit b0ec465b5d7385c8563fba75ff346d3e64e51d9d. Added installation instructions without ade Signed-off-by: Ignacio Montesino <ignaciomontesino@eprosima.com> Rename and move documentation pages for clarity Small fixes in installation instructions Create new Building page which centralizes DDS vendor info, split up troubleshooting Reviewer comments Touch up docs on installing/building [!808] Move index files for design docs and expand into README files [!821] Fix numerours code highlighting and markup issues, add TOCs - TOC still missing on design docs [!828] Update documentation for demos for Foxy [!835] Add AVP instructions to docs Other improvements of the docs include - table-of-contents generation fixed - replace links to external markdown files with HTML. Not sure why doxygen doesn't complain in CI, it failed with version 1.8.13 in my ADE - spell checking of numerous documents - remove subtree doc [!847] Add instructions for native arm64 ADE docker launch - Fix small typos and consistency in bash command style [#888] Add doc information about checking out release specific branches [861] Make code idiomatic for Foxy after 1.0 release [#912] Make code snippet blocks consistent in documentation [#1024] Add Point Type Adapter Node [#1143] Document ROS_VERSION on non-ade install ROS_VERSION needs to be set in order for the dependencies of the tvm_vendor package to be correclty found. Issue-Id: SCM-1400 Signed-off-by: Ambroise Vincent <ambroise.vincent@arm.com> Change-Id: Id1c26514f1ba36688ac3a484decc69d4447cbd6e [#1099] Add ground_truth_detections package update installation-ade.md to fix the wrong path [#904] Move AVP Launch, Config, and Param Files into autoware_demos and Deprecate autoware_auto_avp_demo [#1281] Add non-ade troubleshooting section on installation [#1269] Enabling GPU acceleration by default in ade fix link to avp_sensors.json in LGSVL installation docs [#1358] Get AVP Demo to work with SVL Simulator 2021.3 Release
kenji-miyake
force-pushed
the
add-installation-steps
branch
2 times, most recently
from
373ae8f
to
ab0b17d
Compare
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
kenji-miyake
force-pushed
the
add-installation-steps
branch
from
ab0b17d
to
27ca783
Compare
kenji-miyake
commented
Feb 16, 2022
| @@ -16,5 +16,5 @@ Source installation is for the cases where more granular control of the installa | |||
| It is recommended for skilled users or people who want to customize the environment. | |||
| Note that some problems may occur depending on your local environment. | |||
|
|
|||
| See [here](autoware/source-installation.md) for the detailed steps. | |||
| See [here](source-installation.md) for the detailed steps. | |||
| Refer to the [autowarefoundation/autoware/README.md](https://github.com/autowarefoundation/autoware/blob/main/README.md) as well. | |||
There was a problem hiding this comment.
FYI: I found these mistakes by markdown-link-check.
https://github.com/autowarefoundation/autoware-documentation/runs/5192742237?check_suite_focus=true
This was referenced Feb 18, 2022
xmfcx
approved these changes
Mar 11, 2022
There was a problem hiding this comment.
@kenji-miyake thanks for all the work. Let's merge this and we can iterate over it as we proceed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related: #6, #8
I copied Autoware.Auto's documents, simplified it, and updated it for
autoware.universe.