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(how-to): rename how to guide section #147

Merged
2 commits merged into from Jun 21, 2022
Merged

feat(how-to): rename how to guide section #147

2 commits merged into from Jun 21, 2022

Conversation

ghost
Copy link

@ghost ghost commented Jun 21, 2022

Description

Rename "how-to guide" section to "advanced" and move to the tutorials folder

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.

Lalith Vipulananthan added 2 commits June 21, 2022 14:40
Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
Signed-off-by: Lalith Vipulananthan <lalith.vipulananthan@tier4.jp>
@ghost ghost changed the title feat(how-to): Rename how to guide section Rename how to guide section Jun 21, 2022
@ghost ghost changed the title Rename how to guide section feat: Rename how to guide section Jun 21, 2022
@ghost ghost changed the title feat: Rename how to guide section feat(how-to): rename how to guide section Jun 21, 2022
@ghost ghost requested review from soblin and kenji-miyake June 21, 2022 05:48
@ghost
Copy link
Author

ghost commented Jun 21, 2022

#126 is unfortunately blocked due to a merge conflict that I wasn't able to resolve, so I thought it might be quicker to submit a clean new PR instead.

@ghost ghost merged commit cc47234 into autowarefoundation:main Jun 21, 2022
@ghost ghost deleted the rename-how-to-guide-section branch June 21, 2022 06:35
@kenji-miyake
Copy link
Contributor

@LalithVipulananthan I'm sorry but I wanted you to wait for my review. 😢
I personally think that:

  • Tutorial should be step-by-step documents that we want everyone to do.
  • How-to guides should be other documents that we don't think everyone needs them.

So I recommend reverting this. What do you think?

@kenji-miyake
Copy link
Contributor

Also, if you want to change the structure, which is a relatively big change, you had to write more background information and reasons in the description so that others can understand it.

@ghost
Copy link
Author

ghost commented Jun 21, 2022

@kenji-miyake I apologise for both merging without your review and for the lack of detail in the PR.

Based on your comment on @soblin's original PR, I had assumed that you were okay with the proposed structural change and so that's why I didn't give so much detail for this PR and also why I merged it as soon as @soblin approved the PR.

Whilst we are here, @kminoda was proposing that the scenario testing tutorials should be moved into an advanced tutorials section, which kind of overlaps with this PR.

Perhaps it would be an idea to create a Design discussion to make proposals and suggestions on how to handle advanced tutorials and how-to guides?

@kenji-miyake
Copy link
Contributor

@LalithVipulananthan I'm sorry for my unclear comment. 🙇 But I just commented and didn't approve it.

that's why I didn't give so much detail for this PR

It wasn't good because the reasons of changes aren't clear if I see #126.

Whilst we are here, @kminoda was proposing that the scenario testing tutorials should be moved into an advanced tutorials section, which kind of overlaps with this PR.

I think it's good, but to do that, we didn't have to move all contents from how-to guides.

Perhaps it would be an idea to create a Design discussion to make proposals and suggestions on how to handle advanced tutorials and how-to guides?

Yes, it's a good idea. But before that, I think it's good to revert this to avoid confusion.

@kenji-miyake
Copy link
Contributor

For example, considering Running Autoware without CUDA, is this a tutorial? I don't think so.

@ghost
Copy link
Author

ghost commented Jun 21, 2022

@kenji-miyake

Yes, it's a good idea. But before that, I think it's good to revert this to avoid confusion.

Understood. So, what is the best way to revert this change?

@kenji-miyake
Copy link
Contributor

Just click this button. I'll do it this time.
image

kenji-miyake added a commit that referenced this pull request Jun 21, 2022
kenji-miyake added a commit that referenced this pull request Jun 21, 2022
Revert "feat(how-to): rename how to guide section (#147)"

This reverts commit cc47234.
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants