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.

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

docs: add installation steps of tools for developers #24

Merged
merged 19 commits into from
Mar 11, 2022

Conversation

kenji-miyake
Copy link
Contributor

No description provided.

Joshua Whitley and others added 6 commits February 10, 2022 13:17
[#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 <[email protected]>

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 <[email protected]>
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
Signed-off-by: Kenji Miyake <[email protected]>
Create new Building page which centralizes DDS vendor info, split up troubleshooting

Reorganize building & other sections

Apply 1 suggestion(s) to 1 file(s)

Reviewer comments

Add separate DDS vendor page, mention git lfs download

Move DDS info back to building, remove recommendation for Release build since autoware_compile_options does that by default

Reviewer comments

DDS vendor info by Esteve

Touch up docs on installing/building

[!821] Fix numerours code highlighting and markup issues, add TOCs

- TOC still missing on design docs

[!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

[!833] Add Clion configuration and more build instructions to docs

Added section about colcon defaults

[#912] Make code snippet blocks consistent in documentation

[#813] use autoware_set_compile_options() for nearly all compiled tests

- fix a few causes of warnings and disable warning flags as needed for
other tests
- set CXX_STANDARD strictly and only in a single place
- add CMake flag `AUTOWARE_OPTIMIZATION_OF_SLOW_TARGETS`. Default: OFF
- update building instructions and MR template
- fix nasty initialization error of static constexpr member in `GenericState`
of Kalman filter

[#996] fix bashrc append in documentation

export XXX=YYY >> ~/.bashrc has no effect
echo "export XXX=YYY" >> ~/.bashrc is correct

[#721] Add neural_networks package

It provides a pool of compiled networks to the packages using them.

Issue-Id: SCM-2176
Signed-off-by: Ambroise Vincent <[email protected]>
Change-Id: If52ebff100eb895ef38c526bee85c40d3b8a0ca6
Signed-off-by: Kenji Miyake <[email protected]>
Signed-off-by: Kenji Miyake <[email protected]>
@kenji-miyake kenji-miyake added the type:documentation Creating or refining documentation. label Feb 10, 2022
Kenji Miyake and others added 3 commits February 14, 2022 23:31
@kenji-miyake kenji-miyake marked this pull request as ready for review February 16, 2022 15:07
Signed-off-by: Kenji Miyake <[email protected]>
xmfcx
xmfcx previously approved these changes Feb 18, 2022
@kenji-miyake
Copy link
Contributor Author

I'll merge this after #18.

.gitignore Outdated Show resolved Hide resolved
This reverts commit 1745ee8.

Signed-off-by: Kenji Miyake <[email protected]>
Kenji Miyake and others added 2 commits February 19, 2022 00:41
Base automatically changed from add-installation-steps to main March 11, 2022 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Creating or refining documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants