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

Add Frequently Asked Question page #329

Open
3 tasks done
zulfaqar-azmi-t4 opened this issue Feb 22, 2023 · 1 comment
Open
3 tasks done

Add Frequently Asked Question page #329

zulfaqar-azmi-t4 opened this issue Feb 22, 2023 · 1 comment
Labels
status:stale Inactive or outdated issues. (auto-assigned) type:documentation Creating or refining documentation.

Comments

@zulfaqar-azmi-t4
Copy link

zulfaqar-azmi-t4 commented Feb 22, 2023

Checklist

  • I've read the contribution guidelines.
  • I've searched other issues and no duplicate issues were found.
  • I've agreed with the maintainers that I can plan this task.

Description

There is a question in Q&A might be frequently asked, i.e.: user thought stderr means build failure.
https://github.com/orgs/autowarefoundation/discussions/3269
autowarefoundation/autoware#3282
https://github.com/orgs/autowarefoundation/discussions/2731
autowarefoundation/autoware#2726

Therefore I wonder whether we should create FAQ section that specifically explains about the duplicated question.

Purpose

To reduce number of duplicated question and has a page that provides explanation so that contributor can provide link to the answer.

Possible approaches

  1. Create and FAQ page.
  2. Warns the user to search the FAQ first before placing their question.

Definition of done

FAQ page created

@zulfaqar-azmi-t4 zulfaqar-azmi-t4 added the type:documentation Creating or refining documentation. label Feb 22, 2023
@stale
Copy link

stale bot commented Apr 23, 2023

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 Apr 23, 2023
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) type:documentation Creating or refining documentation.
Projects
None yet
Development

No branches or pull requests

1 participant