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

feat: improve additional-settings-for-developers section #587

Merged
merged 25 commits into from
Jul 17, 2024

Conversation

xmfcx
Copy link
Contributor

@xmfcx xmfcx commented Jul 8, 2024

Description

Parent Issue:

Some updates:

  • Divide additional-settings-for-developers into multiple pages to increase readability and maintainability.
  • Marking export ROS_LOCALHOST_ONLY=1 as a useless act and also telling users to remove it if they've enabled it since it causes problems when cyclone dds is set to use lo.
  • Add more cases where setting a ROS_DOMAIN_ID may fail (e.g. launch_testing utilizes random domain ids to isolate within a machine)
  • Improve DDS tuning section
    • Make default interface as lo instead of autodetermine=true
    • Add all recommended dds stuff here
    • Link it from the installation instructions as these are very important, without these, Autoware never works as expected.
  • Update links within the documentation to changed pages
  • Add google test color option to console settings page
    • Update the broken link on the same page

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.

@xmfcx xmfcx added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Jul 8, 2024
@xmfcx xmfcx self-assigned this Jul 8, 2024
@xmfcx xmfcx force-pushed the feat/dds-isolation branch from 6d9e56f to 8bdafaa Compare July 12, 2024 15:41
M. Fatih Cırıt added 2 commits July 12, 2024 18:45
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>

style(pre-commit): autofix
wip
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
@xmfcx xmfcx force-pushed the feat/dds-isolation branch from 8bdafaa to 8f802f9 Compare July 12, 2024 17:36
M. Fatih Cırıt and others added 13 commits July 16, 2024 18:09
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
@xmfcx xmfcx force-pushed the feat/dds-isolation branch from d9377db to bc6d2b7 Compare July 16, 2024 16:08
pre-commit-ci bot and others added 9 commits July 16, 2024 16:11
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
Signed-off-by: M. Fatih Cırıt <mfc@leodrive.ai>
@xmfcx
Copy link
Contributor Author

xmfcx commented Jul 16, 2024

I've went through the pages many times to make sure everything is well connected and also made sure there are no broken links.

I've looked into the pages from the perspective of both junior and experienced Autoware developers and made sure they all can benefit from the information.

I hope you like the changes too.

@xmfcx xmfcx marked this pull request as ready for review July 16, 2024 17:52
Copy link
Contributor

@yukkysaito yukkysaito left a comment

Choose a reason for hiding this comment

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

LGTM

@xmfcx xmfcx merged commit 7cd0261 into main Jul 17, 2024
9 checks passed
@xmfcx xmfcx deleted the feat/dds-isolation branch July 17, 2024 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants