From e4d71b2c8fdd5281a9571f28afe749e73b8dd4b2 Mon Sep 17 00:00:00 2001 From: Joshua Whitley Date: Tue, 5 Jan 2021 19:45:42 +0000 Subject: [PATCH 01/14] Adding first pass at support guidelines. Rename and move documentation pages for clarity [!808] Move index files for design docs and expand into README files [!821] Fix numerours code highlighting and markup issues, add TOCs - TOC still missing on design docs [!835] Add AVP instructions to docs Other improvements of the docs include - table-of-contents generation fixed - replace links to external markdown files with HTML. Not sure why doxygen doesn't complain in CI, it failed with version 1.8.13 in my ADE - spell checking of numerous documents - remove subtree doc --- docs/support/support-guidelines.md | 51 ++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/support/support-guidelines.md diff --git a/docs/support/support-guidelines.md b/docs/support/support-guidelines.md new file mode 100644 index 00000000000..6be9b81fef9 --- /dev/null +++ b/docs/support/support-guidelines.md @@ -0,0 +1,51 @@ +Support Guidelines {#support-guidelines} +================================ + +@tableofcontents + +# Overview{#support-guidelines-overview} + +We provide several mechanism for getting help and this article describes those mechanisms. +Whether you have run into a problem using Autoware.Auto or you just want more information about some aspect of it not covered in the documentation, one of the below options should have you covered. +Using the correct resource will ensure you get a helpful response to your query quickly. +The following should be the general set of steps for obtaining support, depending on your specific need: + +1. Read the docs +2. Depending on your question: + 1. Ask support questions and describe unconfirmed bugs on [ROS Answers with the `autoware` tag](https://answers.ros.org/questions/ask/?tags=autoware) + 2. Start general Autoware discussions on [the Autoware category at ROS Discourse](https://discourse.ros.org/c/autoware) + 3. For confirmed bugs or feature requests, create a [new issue on the Autoware.Auto Gitlab](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) +3. Message the `committers-autoware-auto` channel [on the Autoware Developer's Slack](https://autoware.herokuapp.com/) + +# General Information: Documentation{#support-guidelines-general-info} + + +Whether you are looking to get help [installing Autoware.Auto](@ref installation), looking for [developer best-practices](@ref contributor-guidelines), or you just want to [run a demo](@ref usage), the auto-generated documentation should be your first resource. +If you find information missing in the docs, please [create a new issue](@ref support-guidelines-gitlab-issues) and, optionally, create a merge request to add the information to the docs yourself. + +# Support Questions: ROS Answers{#support-guidelines-ros-answers} + +If you have a problem with Autoware.Auto and it has not yet been confirmed by others, start your quest at [ROS Answers with the `autoware` tag](https://answers.ros.org/questions/scope:all/sort:activity-desc/tags:autoware/page:1/). +Questions asked with the `autoware` tag are regularly reviewed by Autoware developers and maintainers as well as other members of the Autoware community. + +If your question is not answered within a timely manner (read: at least 1 week - this is an open-source project), then feel free to escalate to either [ROS Discourse](https://discourse.ros.org/c/autoware) or the `committers-autoware-auto` channel [on Slack](https://autoware.herokuapp.com/). + +# General Discussion: ROS Discourse{#support-guidelines-general-discussion} + +If you want to discuss a topic with the general Autoware community or ask a question not related to a problem with Autoware, head over to [the Autoware category on ROS Discourse](https://discourse.ros.org/c/autoware). +The Autoware category is also where high-level announcements are made about Autoware by the Foundation. + +# Confirmed Bugs or Feature Requests: Gitlab Issues{#support-guidelines-gitlab-issues} + +If you have discovered a bug that has been confirmed by others or you would like to request that a new feature be added to Autoware.Auto, consider [creating a new issue on Gitlab](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) and choosing the relevant template. +If you have the background, feel free to also create a Merge Request to resolve the issue! +Just remember to read over our @ref contributors-guide to know what to expect from a review of your Merge Request. + +# Real-time Communication: Autoware Developer's Slack{#support-guidelines-slack} + +Please remember that our [Slack server](https://autoware.herokuapp.com/) is not for any of the cases mentioned above and is mostly a gathering place for developers. +If you are seeking support, want to start a discussion, or want to request a feature, Slack is the wrong avenue. +However, if your question on [ROS Answers](@ref support-guidelines-ros-answers) has gone unanswered for a reasonable amount of time, messaging the `committers-autoware-auto` channel is appropriate. + +The Autoware Developer's Slack is a real-time communication mechanism for person-to-person or group chats. +If you want to take a quick straw-pull survey, chat with a group outside of the primary channels, or introduce yourself to the community, this is a good place to start. From ed0d5d0d784c254e8e0708a3f466ede7e1ee02a6 Mon Sep 17 00:00:00 2001 From: Keisuke Shima <19993104+KeisukeShima@users.noreply.github.com> Date: Thu, 25 Nov 2021 16:52:01 +0900 Subject: [PATCH 02/14] update documents Signed-off-by: Kenji Miyake --- docs/help/support-guidelines.md | 55 ++++++++++++++++++++++++++++-- docs/support/support-guidelines.md | 51 --------------------------- 2 files changed, 52 insertions(+), 54 deletions(-) delete mode 100644 docs/support/support-guidelines.md diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index 4ae6bfd7e0b..c833e969a93 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -1,5 +1,54 @@ -# Support guidelines +# Support Guidelines -!!! warning +## Overview - Under Construction +We provide several mechanism for getting help and this article describes those mechanisms. +Whether you have run into a problem using Autoware.Core or you just want more information about some aspect of it not covered in the documentation, one of the below options should have you covered. +Using the correct resource will ensure you get a helpful response to your query quickly. +The following should be the general set of steps for obtaining support, depending on your specific need: + +1. Read the docs +1. Depending on your question: + 1. Ask support questions and describe unconfirmed bugs on [GitHub discussions][github-discussions] + 1. Start general Autoware discussions on [the Autoware category at ROS Discourse][ros-discourse] + 1. For confirmed bugs or feature requests, create a [new issue on the Autoware.Core GitHub][new-issue] +1. Message the `committers-autoware-core` channel [on the Autoware Developer's Slack][autoware-slack] + +## General Information: Documentation + +Whether you are looking to get help [installing Autoware.Core](installation.md), looking for [developer best-practices](contributor-guidelines/index.md), or you just want to [run a demo](usage/index.md), the auto-generated documentation should be your first resource. +If you find information missing in the docs, please [create a new issue](#confirmed-bugs-or-feature-requests-github-issues) and, optionally, create a merge request to add the information to the docs yourself. + +## Support Questions: GitHub Discussions + +If you have a problem with Autoware.Core and it has not yet been confirmed by others, start your quest at [GitHub discussions][github-discussions]. +Questions asked with the `Q&A` category are regularly reviewed by Autoware developers and maintainers as well as other members of the Autoware community. + +If your question is not answered within a timely manner (read: at least 1 week - this is an open-source project), then feel free to escalate to either [ROS Discourse][ros-discourse] or the `committers-autoware-core` channel [on Slack][autoware-slack]. + +## General Discussion: ROS Discourse + +If you want to discuss a topic with the general Autoware community or ask a question not related to a problem with Autoware, head over to [the Autoware category on ROS Discourse][ros-discourse]. +The Autoware category is also where high-level announcements are made about Autoware by the Foundation. + +## Confirmed Bugs or Feature Requests: GitHub Issues + +If you have discovered a bug that has been confirmed by others or you would like to request that a new feature be added to Autoware.Auto, consider [creating a new issue on GitHub][new-issue] and choosing the relevant template. +If you have the background, feel free to also create a Merge Request to resolve the issue! +Just remember to read over our [Contributor's Guide](contributors-guide/index.md) to know what to expect from a review of your Pull Request. + +## Real-time Communication: Autoware Developer's Slack + +Please remember that our [Slack server][autoware-slack] is not for any of the cases mentioned above and is mostly a gathering place for developers. +If you are seeking support, want to start a discussion, or want to request a feature, Slack is the wrong avenue. +However, if your question on [GitHub Discussions](#support-questions-gitHub-discussions) has gone unanswered for a reasonable amount of time, messaging the `committers-autoware-core` channel is appropriate. + +The Autoware Developer's Slack is a real-time communication mechanism for person-to-person or group chats. +If you want to take a quick straw-pull survey, chat with a group outside of the primary channels, or introduce yourself to the community, this is a good place to start. + + + +[github-discussions]: https://github.com/autowarefoundation/autoware/discussions +[ros-discourse]: https://discourse.ros.org/c/autoware +[new-issue]: https://github.com/autowarefoundation/autoware/issues/new +[autoware-slack]: https://autoware.herokuapp.com/ diff --git a/docs/support/support-guidelines.md b/docs/support/support-guidelines.md deleted file mode 100644 index 6be9b81fef9..00000000000 --- a/docs/support/support-guidelines.md +++ /dev/null @@ -1,51 +0,0 @@ -Support Guidelines {#support-guidelines} -================================ - -@tableofcontents - -# Overview{#support-guidelines-overview} - -We provide several mechanism for getting help and this article describes those mechanisms. -Whether you have run into a problem using Autoware.Auto or you just want more information about some aspect of it not covered in the documentation, one of the below options should have you covered. -Using the correct resource will ensure you get a helpful response to your query quickly. -The following should be the general set of steps for obtaining support, depending on your specific need: - -1. Read the docs -2. Depending on your question: - 1. Ask support questions and describe unconfirmed bugs on [ROS Answers with the `autoware` tag](https://answers.ros.org/questions/ask/?tags=autoware) - 2. Start general Autoware discussions on [the Autoware category at ROS Discourse](https://discourse.ros.org/c/autoware) - 3. For confirmed bugs or feature requests, create a [new issue on the Autoware.Auto Gitlab](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) -3. Message the `committers-autoware-auto` channel [on the Autoware Developer's Slack](https://autoware.herokuapp.com/) - -# General Information: Documentation{#support-guidelines-general-info} - - -Whether you are looking to get help [installing Autoware.Auto](@ref installation), looking for [developer best-practices](@ref contributor-guidelines), or you just want to [run a demo](@ref usage), the auto-generated documentation should be your first resource. -If you find information missing in the docs, please [create a new issue](@ref support-guidelines-gitlab-issues) and, optionally, create a merge request to add the information to the docs yourself. - -# Support Questions: ROS Answers{#support-guidelines-ros-answers} - -If you have a problem with Autoware.Auto and it has not yet been confirmed by others, start your quest at [ROS Answers with the `autoware` tag](https://answers.ros.org/questions/scope:all/sort:activity-desc/tags:autoware/page:1/). -Questions asked with the `autoware` tag are regularly reviewed by Autoware developers and maintainers as well as other members of the Autoware community. - -If your question is not answered within a timely manner (read: at least 1 week - this is an open-source project), then feel free to escalate to either [ROS Discourse](https://discourse.ros.org/c/autoware) or the `committers-autoware-auto` channel [on Slack](https://autoware.herokuapp.com/). - -# General Discussion: ROS Discourse{#support-guidelines-general-discussion} - -If you want to discuss a topic with the general Autoware community or ask a question not related to a problem with Autoware, head over to [the Autoware category on ROS Discourse](https://discourse.ros.org/c/autoware). -The Autoware category is also where high-level announcements are made about Autoware by the Foundation. - -# Confirmed Bugs or Feature Requests: Gitlab Issues{#support-guidelines-gitlab-issues} - -If you have discovered a bug that has been confirmed by others or you would like to request that a new feature be added to Autoware.Auto, consider [creating a new issue on Gitlab](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) and choosing the relevant template. -If you have the background, feel free to also create a Merge Request to resolve the issue! -Just remember to read over our @ref contributors-guide to know what to expect from a review of your Merge Request. - -# Real-time Communication: Autoware Developer's Slack{#support-guidelines-slack} - -Please remember that our [Slack server](https://autoware.herokuapp.com/) is not for any of the cases mentioned above and is mostly a gathering place for developers. -If you are seeking support, want to start a discussion, or want to request a feature, Slack is the wrong avenue. -However, if your question on [ROS Answers](@ref support-guidelines-ros-answers) has gone unanswered for a reasonable amount of time, messaging the `committers-autoware-auto` channel is appropriate. - -The Autoware Developer's Slack is a real-time communication mechanism for person-to-person or group chats. -If you want to take a quick straw-pull survey, chat with a group outside of the primary channels, or introduce yourself to the community, this is a good place to start. From b50377776044aa57a57e28dc08265a988f8da4cb Mon Sep 17 00:00:00 2001 From: Kenji Miyake Date: Thu, 17 Feb 2022 11:23:24 +0900 Subject: [PATCH 03/14] update documents Signed-off-by: Kenji Miyake --- docs/help/docs-guide.md | 2 +- docs/help/support-guidelines.md | 106 +++++++++++++++++++++----------- 2 files changed, 70 insertions(+), 38 deletions(-) diff --git a/docs/help/docs-guide.md b/docs/help/docs-guide.md index 6f7f3782d35..a67d21fc7e4 100644 --- a/docs/help/docs-guide.md +++ b/docs/help/docs-guide.md @@ -4,7 +4,7 @@ Under Construction -This page explains documentations sites that are useful for Autoware and ROS development. +This page explains several documentation sites that are useful for Autoware and ROS development. ## [The Autoware Foundation](https://www.autoware.org/) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index c833e969a93..d25d162cc12 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -1,54 +1,86 @@ -# Support Guidelines +# Support guidelines -## Overview +This page explains the support mechanisms we provide. -We provide several mechanism for getting help and this article describes those mechanisms. -Whether you have run into a problem using Autoware.Core or you just want more information about some aspect of it not covered in the documentation, one of the below options should have you covered. -Using the correct resource will ensure you get a helpful response to your query quickly. -The following should be the general set of steps for obtaining support, depending on your specific need: +!!! warning -1. Read the docs -1. Depending on your question: - 1. Ask support questions and describe unconfirmed bugs on [GitHub discussions][github-discussions] - 1. Start general Autoware discussions on [the Autoware category at ROS Discourse][ros-discourse] - 1. For confirmed bugs or feature requests, create a [new issue on the Autoware.Core GitHub][new-issue] -1. Message the `committers-autoware-core` channel [on the Autoware Developer's Slack][autoware-slack] + Before asking any help, search and read this documentation site carefully. + Also, understand and follow our [discussion guidelines](../contributing/discussion-guidelines/index.md) during your discussions. -## General Information: Documentation +Choose appropriate resources depending on what kind of help you need: -Whether you are looking to get help [installing Autoware.Core](installation.md), looking for [developer best-practices](contributor-guidelines/index.md), or you just want to [run a demo](usage/index.md), the auto-generated documentation should be your first resource. -If you find information missing in the docs, please [create a new issue](#confirmed-bugs-or-feature-requests-github-issues) and, optionally, create a merge request to add the information to the docs yourself. +- Documentation sites + - Various information +- GitHub Discussions + - Questions + - Unconfirmed bugs + - Feature requests + - Design discussions +- GitHub Issues + - Confirmed bugs +- Slack + - Instant messaging between contributors +- ROS Discourse + - General topics that should be widely announced -## Support Questions: GitHub Discussions +The following sections are detailed descriptions of each resource. -If you have a problem with Autoware.Core and it has not yet been confirmed by others, start your quest at [GitHub discussions][github-discussions]. -Questions asked with the `Q&A` category are regularly reviewed by Autoware developers and maintainers as well as other members of the Autoware community. +## Documentation sites -If your question is not answered within a timely manner (read: at least 1 week - this is an open-source project), then feel free to escalate to either [ROS Discourse][ros-discourse] or the `committers-autoware-core` channel [on Slack][autoware-slack]. +[Docs guide](docs-guide.md) shows the list of useful documentation sites. +Visit them and see if there is any information related to your problem. -## General Discussion: ROS Discourse +Note that the documentation sites aren't always latest and perfect. +If you find some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following our [contribution guidelines](../contributing/index.md). -If you want to discuss a topic with the general Autoware community or ask a question not related to a problem with Autoware, head over to [the Autoware category on ROS Discourse][ros-discourse]. -The Autoware category is also where high-level announcements are made about Autoware by the Foundation. +!!!warning -## Confirmed Bugs or Feature Requests: GitHub Issues + Since this documentation site is still under construction, there are some empty pages. -If you have discovered a bug that has been confirmed by others or you would like to request that a new feature be added to Autoware.Auto, consider [creating a new issue on GitHub][new-issue] and choosing the relevant template. -If you have the background, feel free to also create a Merge Request to resolve the issue! -Just remember to read over our [Contributor's Guide](contributors-guide/index.md) to know what to expect from a review of your Pull Request. +## GitHub Discussions -## Real-time Communication: Autoware Developer's Slack +If you have a problem with Autoware, check existing issues and questions and search similar issues first. -Please remember that our [Slack server][autoware-slack] is not for any of the cases mentioned above and is mostly a gathering place for developers. -If you are seeking support, want to start a discussion, or want to request a feature, Slack is the wrong avenue. -However, if your question on [GitHub Discussions](#support-questions-gitHub-discussions) has gone unanswered for a reasonable amount of time, messaging the `committers-autoware-core` channel is appropriate. +- [Issues](https://github.com/autowarefoundation/autoware/issues) -The Autoware Developer's Slack is a real-time communication mechanism for person-to-person or group chats. -If you want to take a quick straw-pull survey, chat with a group outside of the primary channels, or introduce yourself to the community, this is a good place to start. + Note that Autoware has multiple repositories listed in [autoware.repos](https://github.com/autowarefoundation/autoware/blob/main/autoware.repos). + It is recommended to search across the repositories. - +- [Questions](https://github.com/autowarefoundation/autoware/discussions/categories/q-a) -[github-discussions]: https://github.com/autowarefoundation/autoware/discussions -[ros-discourse]: https://discourse.ros.org/c/autoware -[new-issue]: https://github.com/autowarefoundation/autoware/issues/new -[autoware-slack]: https://autoware.herokuapp.com/ +If no answer was found, create a new question thread [here](https://github.com/autowarefoundation/autoware/discussions/new?category=q-a). +If your question is not answered in a timely manner (about a week), mention maintainers and remind them. + +Also, there are other discussion types such as [feature requests](https://github.com/autowarefoundation/autoware/discussions/categories/feature-requests) or [design discussions](https://github.com/autowarefoundation/autoware/discussions/categories/design). +Feel free to open or join such discussions. + +## GitHub Issues + +If you have a problem and you have confirmed it is a bug, find the appropriate repository and create a new issue there. +If you can't determine the appropriate repository, you should not create an issue yet. + +!!!warning + + Do not create issues for questions or unconfirmed bugs. If such issues are created, maintainers will transfer them to GitHub Discussions. + +If you want to fix the bug by yourself, discuss the approach with maintainers and submit a pull request. + +## Slack + +Autoware has a Slack workspace for casual communication between contributors. + +For example, this is a good place for the following activities: + +- Introduce yourself to the community. +- Chat with contributors. +- Take a quick straw poll. + +Note that it is not the right place to get help for your issues. + +## ROS Discourse + +If you want to widely discuss a topic with the general Autoware community or ask a question not related to Autoware's bugs, post to [the Autoware category on ROS Discourse](https://discourse.ros.org/c/autoware). + +!!!warning + + Do not post questions about bugs to ROS Discourse! From ae7fe87953f66dff58bde36fdb1568d82972ef43 Mon Sep 17 00:00:00 2001 From: Kenji Miyake Date: Thu, 3 Mar 2022 22:52:20 +0900 Subject: [PATCH 04/14] change link Signed-off-by: Kenji Miyake --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index d25d162cc12..15eeb2b0ad1 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -48,7 +48,7 @@ If you have a problem with Autoware, check existing issues and questions and sea - [Questions](https://github.com/autowarefoundation/autoware/discussions/categories/q-a) -If no answer was found, create a new question thread [here](https://github.com/autowarefoundation/autoware/discussions/new?category=q-a). +If no answer was found, create a new question thread [here](https://github.com/autowarefoundation/autoware/discussions/categories/q-a). If your question is not answered in a timely manner (about a week), mention maintainers and remind them. Also, there are other discussion types such as [feature requests](https://github.com/autowarefoundation/autoware/discussions/categories/feature-requests) or [design discussions](https://github.com/autowarefoundation/autoware/discussions/categories/design). From c989428844daf0ee2479aec893df109571ab8aaf Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Wed, 9 Mar 2022 22:08:58 +0900 Subject: [PATCH 05/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index 15eeb2b0ad1..b29dfcbd1ce 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -9,18 +9,18 @@ This page explains the support mechanisms we provide. Choose appropriate resources depending on what kind of help you need: -- Documentation sites +- **Documentation sites** - Various information -- GitHub Discussions +- **GitHub Discussions** - Questions - Unconfirmed bugs - Feature requests - Design discussions -- GitHub Issues +- **GitHub Issues** - Confirmed bugs -- Slack +- **Slack** - Instant messaging between contributors -- ROS Discourse +- **ROS Discourse** - General topics that should be widely announced The following sections are detailed descriptions of each resource. From 6dc8e2773e08deb9284b10a944d86a7b489857f7 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Wed, 9 Mar 2022 22:09:38 +0900 Subject: [PATCH 06/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index b29dfcbd1ce..bc9be3cff05 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -30,7 +30,7 @@ The following sections are detailed descriptions of each resource. [Docs guide](docs-guide.md) shows the list of useful documentation sites. Visit them and see if there is any information related to your problem. -Note that the documentation sites aren't always latest and perfect. +Note that the documentation sites aren't always up-to-date and perfect. If you find some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following our [contribution guidelines](../contributing/index.md). !!!warning From 29ad306fb5bbd4a4d28d3ce67b58ed3f172f1eca Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Wed, 9 Mar 2022 22:13:17 +0900 Subject: [PATCH 07/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index bc9be3cff05..c444a7e816e 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -4,7 +4,7 @@ This page explains the support mechanisms we provide. !!! warning - Before asking any help, search and read this documentation site carefully. + Before asking for help, search and read this documentation site carefully. Also, understand and follow our [discussion guidelines](../contributing/discussion-guidelines/index.md) during your discussions. Choose appropriate resources depending on what kind of help you need: From a9f5035ac53b115537627e46613f0ec21fc49556 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Wed, 9 Mar 2022 22:13:58 +0900 Subject: [PATCH 08/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index c444a7e816e..f8bbfb60cb9 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -31,7 +31,7 @@ The following sections are detailed descriptions of each resource. Visit them and see if there is any information related to your problem. Note that the documentation sites aren't always up-to-date and perfect. -If you find some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following our [contribution guidelines](../contributing/index.md). +If you find out that some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following our [contribution guidelines](../contributing/index.md). !!!warning From 413852c7c02d9c75f71dfc867e5bdb5853b0719b Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Wed, 9 Mar 2022 23:43:45 +0900 Subject: [PATCH 09/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index f8bbfb60cb9..d8f581adf4b 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -39,7 +39,7 @@ If you find out that some information is wrong, unclear, or missing in Autoware ## GitHub Discussions -If you have a problem with Autoware, check existing issues and questions and search similar issues first. +If you encounter a problem with Autoware, check existing issues and questions and search for similar issues first. - [Issues](https://github.com/autowarefoundation/autoware/issues) From f649d651a5f5f6c6f3614335617d0cdd1f48265e Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Thu, 10 Mar 2022 00:13:59 +0900 Subject: [PATCH 10/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index d8f581adf4b..718911baa39 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -79,7 +79,7 @@ Note that it is not the right place to get help for your issues. ## ROS Discourse -If you want to widely discuss a topic with the general Autoware community or ask a question not related to Autoware's bugs, post to [the Autoware category on ROS Discourse](https://discourse.ros.org/c/autoware). +If you want to widely discuss a topic with the general Autoware and ROS community or ask a question not related to Autoware's bugs, post to [the Autoware category on ROS Discourse](https://discourse.ros.org/c/autoware). !!!warning From 5fcad549196a5cb9a7c1392b84746a7099545b86 Mon Sep 17 00:00:00 2001 From: Kenji Miyake Date: Thu, 10 Mar 2022 20:03:27 +0900 Subject: [PATCH 11/14] apply review Signed-off-by: Kenji Miyake --- docs/help/support-guidelines.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index 718911baa39..fbcd2357ac7 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -7,24 +7,22 @@ This page explains the support mechanisms we provide. Before asking for help, search and read this documentation site carefully. Also, understand and follow our [discussion guidelines](../contributing/discussion-guidelines/index.md) during your discussions. -Choose appropriate resources depending on what kind of help you need: +Choose appropriate resources depending on what kind of help you need and read the detailed description in the sections below. -- **Documentation sites** +- [Documentation sites](#documentation-sites) - Various information -- **GitHub Discussions** +- [GitHub Discussions](#github-discussions) - Questions - Unconfirmed bugs - Feature requests - Design discussions -- **GitHub Issues** +- [GitHub Issues](#github-issues) - Confirmed bugs -- **Slack** +- [Slack](#slack) - Instant messaging between contributors -- **ROS Discourse** +- [ROS Discourse](#ros-discourse) - General topics that should be widely announced -The following sections are detailed descriptions of each resource. - ## Documentation sites [Docs guide](docs-guide.md) shows the list of useful documentation sites. From 30a665fd010da5f82438a6b14275e4c1fda0fccb Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:09:51 +0900 Subject: [PATCH 12/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index fbcd2357ac7..6d6dae1fc9c 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -55,7 +55,7 @@ Feel free to open or join such discussions. ## GitHub Issues If you have a problem and you have confirmed it is a bug, find the appropriate repository and create a new issue there. -If you can't determine the appropriate repository, you should not create an issue yet. +If you can't determine the appropriate repository, ask the maintainers for help by creating a new discussion in the [Q&A category](https://github.com/autowarefoundation/autoware/discussions/categories/q-a). !!!warning From 38811768222e26e41bdf67b14eb05ec85c43748a Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Fri, 11 Mar 2022 10:12:27 +0900 Subject: [PATCH 13/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index 6d6dae1fc9c..5e3c650561c 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -47,7 +47,7 @@ If you encounter a problem with Autoware, check existing issues and questions an - [Questions](https://github.com/autowarefoundation/autoware/discussions/categories/q-a) If no answer was found, create a new question thread [here](https://github.com/autowarefoundation/autoware/discussions/categories/q-a). -If your question is not answered in a timely manner (about a week), mention maintainers and remind them. +If your question is not answered within a week, then @mention the maintainers to remind them. Also, there are other discussion types such as [feature requests](https://github.com/autowarefoundation/autoware/discussions/categories/feature-requests) or [design discussions](https://github.com/autowarefoundation/autoware/discussions/categories/design). Feel free to open or join such discussions. From c9ad98cc50c2ffbc46eeef259c6e099352686c84 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Fri, 11 Mar 2022 19:38:05 +0900 Subject: [PATCH 14/14] Update docs/help/support-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/help/support-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md index 5e3c650561c..f877e8d1b34 100644 --- a/docs/help/support-guidelines.md +++ b/docs/help/support-guidelines.md @@ -5,7 +5,7 @@ This page explains the support mechanisms we provide. !!! warning Before asking for help, search and read this documentation site carefully. - Also, understand and follow our [discussion guidelines](../contributing/discussion-guidelines/index.md) during your discussions. + Also, follow the [discussion guidelines](../contributing/discussion-guidelines/index.md) for discussions. Choose appropriate resources depending on what kind of help you need and read the detailed description in the sections below.