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(launch-autoware): add how to launch yabloc or eagleye #411

Conversation

KYabuuchi
Copy link
Contributor

@KYabuuchi KYabuuchi commented Jun 27, 2023

Description

  • Added a new page: "How to guides/5. Launch Autoware".
  • Organized the startup procedures for YabLoc and Eagleye and made changes to the page hierarchy.
  • Provided additional details about YabLoc.

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.

KYabuuchi and others added 10 commits June 27, 2023 11:45
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
@KYabuuchi KYabuuchi added tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) component:localization Vehicle's position determination in its environment. labels Jun 27, 2023
@KYabuuchi KYabuuchi changed the title Docs/how to launch yabloc or eagleye docs(launch-autoware): how to launch yabloc or eagleye Jun 27, 2023
@KYabuuchi KYabuuchi changed the title docs(launch-autoware): how to launch yabloc or eagleye docs(launch-autoware): add how to launch yabloc or eagleye Jun 27, 2023
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
@KYabuuchi KYabuuchi marked this pull request as ready for review June 27, 2023 04:57
@KYabuuchi
Copy link
Contributor Author

Hi! This PR is now ready for review.

I would like each of you to review the following: 🙏
@yukkysaito @mitsudome-r : the hierarchy structure of the documentation pages.
@rsasaki0109 : about Eagleye. Specifically, "Localization mode" and "Eagleye guide".

@yukkysaito
Copy link
Contributor

@KYabuuchi Thank you for your PR. LGTM 👍

@KYabuuchi KYabuuchi requested a review from kminoda June 27, 2023 05:26
@KYabuuchi
Copy link
Contributor Author

@kminoda I hope you take a look at "YabLoc" and "Localization mode" 🙏

Copy link
Contributor

@kminoda kminoda left a comment

Choose a reason for hiding this comment

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

Cool!! Thank you for the document 🙏
Maybe this comment be better to handled first #411 (comment)

Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
@KYabuuchi
Copy link
Contributor Author

@kminoda I have moved the introduction of YabLoc to the README in autoware.universe. The reviews pointed out have been reflected there. autowarefoundation/autoware.universe#4100

kminoda
kminoda previously approved these changes Jun 28, 2023
Copy link
Contributor

@kminoda kminoda left a comment

Choose a reason for hiding this comment

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

LGTM!!

@kminoda kminoda dismissed their stale review June 29, 2023 01:09

Let me ask you one question in slack

Copy link
Contributor

@kminoda kminoda left a comment

Choose a reason for hiding this comment

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

I once dismissed the approval since I got confused with the localization_mode and pose_estimator_mode, but now it's clear that it's not an error (complicated though), so LGTM again!

@KYabuuchi KYabuuchi added tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) and removed tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) component:localization Vehicle's position determination in its environment. labels Jun 29, 2023
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
Signed-off-by: Kento Yabuuchi <[email protected]>
@KYabuuchi KYabuuchi mentioned this pull request Jun 29, 2023
4 tasks
@KYabuuchi
Copy link
Contributor Author

@rsasaki0109 Hi. I made some minor updates to the Eagleye page, so I would appreciate a quick review to ensure everything looks good. 🙇 🙏

@rsasaki0109
Copy link
Member

Sorry. I did not notice the notification. I will check.

Copy link
Member

@rsasaki0109 rsasaki0109 left a comment

Choose a reason for hiding this comment

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

@KYabuuchi
This PR looks very good to me.
There are no issues to point out.

@KYabuuchi KYabuuchi merged commit acda2fe into autowarefoundation:main Jul 5, 2023
@KYabuuchi KYabuuchi deleted the docs/how_to_launch_yabloc_or_eagleye branch July 5, 2023 04:02
alanmengg pushed a commit to alanmengg/autoware-documentation that referenced this pull request Aug 2, 2023
…oundation#411)

* add yabloc page but it's empty

Signed-off-by: Kento Yabuuchi <[email protected]>

* update yabloc-integration-guide

Signed-off-by: Kento Yabuuchi <[email protected]>

* style(pre-commit): autofix

* add what is YabLoc

Signed-off-by: Kento Yabuuchi <[email protected]>

* moved yabloc and eagleye docs under launch-autoware

Signed-off-by: Kento Yabuuchi <[email protected]>

* WIP add some descriptions in Japanese

Signed-off-by: Kento Yabuuchi <[email protected]>

* WIP update

Signed-off-by: Kento Yabuuchi <[email protected]>

* modified structure

Signed-off-by: Kento Yabuuchi <[email protected]>

* translate in english

Signed-off-by: Kento Yabuuchi <[email protected]>

* applied pre-commit

Signed-off-by: Kento Yabuuchi <[email protected]>

* fix typo

Signed-off-by: Kento Yabuuchi <[email protected]>

* fix typo again

Signed-off-by: Kento Yabuuchi <[email protected]>

* reflected reviews

Signed-off-by: Kento Yabuuchi <[email protected]>

* removed yabloc sub-page

Signed-off-by: Kento Yabuuchi <[email protected]>

* add comprehensive table

Signed-off-by: Kento Yabuuchi <[email protected]>

* use markdown rather than html

Signed-off-by: Kento Yabuuchi <[email protected]>

* i dont know why the table does not appear

Signed-off-by: Kento Yabuuchi <[email protected]>

* update table

Signed-off-by: Kento Yabuuchi <[email protected]>

* today's CI is annoying

Signed-off-by: Kento Yabuuchi <[email protected]>

* split table

Signed-off-by: Kento Yabuuchi <[email protected]>

---------

Signed-off-by: Kento Yabuuchi <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Signed-off-by: guiping meng <[email protected]>
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants