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: refactoring integration pages #493

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ismetatabay
Copy link
Member

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.

Signed-off-by: ismetatabay <[email protected]>
@ismetatabay ismetatabay changed the title refactor: integration pages docs: refactoring integration pages Dec 5, 2023
Signed-off-by: ismetatabay <[email protected]>
@ismetatabay ismetatabay added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Dec 5, 2023
Copy link

github-actions bot commented Dec 5, 2023

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

Copy link

stale bot commented Feb 3, 2024

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the status:stale Inactive or outdated issues. (auto-assigned) label Feb 3, 2024
@stale stale bot removed the status:stale Inactive or outdated issues. (auto-assigned) label Feb 26, 2024
Copy link

@dkoldaev dkoldaev left a comment

Choose a reason for hiding this comment

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

Making integration tutorial easily accessible through the top bar is a very nice addition. However, the overview page does not contains any overview that is currently present, and it would be nice to put it back while keeping the Overview page organized as it is in this PR

@@ -0,0 +1,39 @@
# Overview
Copy link

Choose a reason for hiding this comment

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

Previous page had a bit more information on the context of the integration. While this pr seem to organize the integration tutorial, it also makes it less transparent on the roles of each step. As a solution, I would propose to add more information at each of the section. Maybe adding an objection subsection to each of the sections would be nice before providing the link. For example, for the vehicle_inteface section it could be: "To integrate Autoware into a real vehicle, it is necessary to connect the vehicle base controller with the Autoware control module. In a nutshell, in this section we develop a ROS2 package called vehicle_interface that serves two purposes: 1. Receiving Autoware velocity commands through ROS2 topics, converting them into the vehicle specific commands and propagating them to the vehicle through thevehicle specific API. 2. Receiving the vehicle state through the vehicle specific API and propagating it to Autoware through ROS2 topics."

Copy link

stale bot commented May 4, 2024

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the status:stale Inactive or outdated issues. (auto-assigned) label May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:stale Inactive or outdated issues. (auto-assigned) tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants