Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ nav:
- Reference HW: reference-hw
- contributing
- datasets
- support
- Competitions: autoware-competitions
- community
3 changes: 3 additions & 0 deletions docs/community/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- support
- Competitions: autoware-competitions
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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, follow the [discussion guidelines](../contributing/discussion-guidelines/index.md) for 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.

Expand Down Expand Up @@ -63,7 +63,7 @@ If you are unsure how to create a discussion, refer to the [GitHub Docs on creat
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 out that some information is wrong, unclear, or missing in Autoware docs, feel free to submit a pull request following the [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 the [contribution guidelines](../../contributing/index.md).

## GitHub Discussions

Expand Down Expand Up @@ -120,7 +120,7 @@ When creating a new issue, use the following guidelines:
When you start working on an issue, link the related pull request to the issue by mentioning the issue number.
This helps maintain a clear and traceable development history.

For more details, see the [Pull Request Guidelines page](../contributing/pull-request-guidelines/index.md).
For more details, see the [Pull Request Guidelines page](../../contributing/pull-request-guidelines/index.md).

!!! warning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

If the error is not resolved, remove `src/` and update your workspace according to installation type ([Docker](../../installation/autoware/docker-installation.md#update-the-workspace) / [source](../../installation/autoware/source-installation.md#how-to-update-a-workspace)).
If the error is not resolved, remove `src/` and update your workspace according to installation type ([Docker](../../../installation/autoware/docker-installation.md#update-the-workspace) / [source](../../../installation/autoware/source-installation.md#how-to-update-a-workspace)).

!!! Warning

Expand Down Expand Up @@ -192,7 +192,7 @@

### Map does not display when running the Planning Simulator

When running the Planning Simulator, the most common reason for the map not being displayed in RViz is because [the map path has not been specified correctly in the launch command](../../demos/planning-simulation.md#lane-driving-scenario). You can confirm if this is the case by searching for `Could not find lanelet map under {path-to-map-dir}/lanelet2_map.osm` errors in the log.
When running the Planning Simulator, the most common reason for the map not being displayed in RViz is because [the map path has not been specified correctly in the launch command](../../../demos/planning-simulation.md#lane-driving-scenario). You can confirm if this is the case by searching for `Could not find lanelet map under {path-to-map-dir}/lanelet2_map.osm` errors in the log.

Another possible reason is that map loading is taking a long time due to poor DDS performance. For this, please visit the [Performance Troubleshooting](performance-troubleshooting.md) page.

Expand All @@ -208,7 +208,7 @@
```

In this state, when a died process occurs when you run the autoware again, a core file will be created.
Remeber to remove the size limit of the core file.

Check warning on line 211 in docs/community/support/troubleshooting/index.md

View workflow job for this annotation

GitHub Actions / spell-check-differential

Misspelled word (Remeber) Suggestions: (remember*)

```bash
ulimit -c unlimited
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ If you get the error message `selected interface "{your-interface-name}" is not

#### Solution

Follow [DDS settings for ROS 2 and Autoware](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md)
Follow [DDS settings for ROS 2 and Autoware](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md)

Especially the [Enable `multicast` on `lo`](../../installation/additional-settings-for-developers/network-configuration/enable-multicast-for-lo.md) section.
Especially the [Enable `multicast` on `lo`](../../../installation/additional-settings-for-developers/network-configuration/enable-multicast-for-lo.md) section.

### Check the compilation flags

Expand Down Expand Up @@ -93,7 +93,7 @@ If you are using a different DDS middleware, we might not have official support

Add `export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp` as a separate line in you `~/.bashrc` file.

More details in: [CycloneDDS Configuration](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#cyclonedds-configuration)
More details in: [CycloneDDS Configuration](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#cyclonedds-configuration)

#### Check if the CycloneDDS is configured correctly

Expand All @@ -117,7 +117,7 @@ This should print the `.xml` file on the terminal.

##### Solution

Follow [CycloneDDS Configuration](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#cyclonedds-configuration) and make sure:
Follow [CycloneDDS Configuration](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#cyclonedds-configuration) and make sure:

- you have `export CYCLONEDDS_URI=file:///absolute_path_to_your/cyclonedds.xml` as a line on your `~/.bashrc` file.
- you have the `cyclonedds.xml` with the configuration provided in the documentation.
Expand All @@ -126,11 +126,11 @@ Follow [CycloneDDS Configuration](../../installation/additional-settings-for-dev

##### Diagnosis

[Validate the sysctl settings](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#validate-the-sysctl-settings)
[Validate the sysctl settings](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#validate-the-sysctl-settings)

##### Solution

[Tune system-wide network settings](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#tune-system-wide-network-settings)
[Tune system-wide network settings](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#tune-system-wide-network-settings)

### Check if localhost only communication for DDS is enabled

Expand All @@ -154,11 +154,11 @@ Run:
cat ${CYCLONEDDS_URI#file://}
```

And it should return [DDS settings for ROS 2 and Autoware: CycloneDDS Configuration](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#cyclonedds-configuration) this file.
And it should return [DDS settings for ROS 2 and Autoware: CycloneDDS Configuration](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#cyclonedds-configuration) this file.

#### Solution

Follow [DDS settings for ROS 2 and Autoware: Enable localhost-only communication](../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#enable-localhost-only-communication).
Follow [DDS settings for ROS 2 and Autoware: Enable localhost-only communication](../../../installation/additional-settings-for-developers/network-configuration/dds-settings.md#enable-localhost-only-communication).

Also make sure the following returns an empty line:

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/documentation-guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Examples of small changes include:

- Fixing spelling or grammatical mistakes
- Fixing broken links
- Making an addition to an existing, well-defined page, such as the [Troubleshooting](../../support/troubleshooting/index.md) guide.
- Making an addition to an existing, well-defined page, such as the [Troubleshooting](../../community/support/troubleshooting/index.md) guide.

Examples of larger changes include:

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you are new to open source projects, we recommend reading GitHub's [How to Co

## How can I get help?

Do not open issues for general support questions as we want to keep GitHub issues for confirmed bug reports. Instead, open a discussion in the Q&A category. For more details on the support mechanisms for Autoware, refer to the [Support guidelines](../support/index.md).
Do not open issues for general support questions as we want to keep GitHub issues for confirmed bug reports. Instead, open a discussion in the Q&A category. For more details on the support mechanisms for Autoware, refer to the [Support guidelines](../community/support/index.md).

!!! note

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/pull-request-guidelines/code-owners.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If your PR hasn't been reviewed:

- 🏹 **Directly Address Code Owners**: Comment on the PR to alert the owners.
- ⏳ **Follow Up After a Week**: If unreviewed after a week, add a comment under the PR and tag the `@autoware-maintainers`.
- 📢 **Escalate if Necessary**: If your requests continue to go unanswered, you may escalate the issue by posting a message in the [Autoware Discord channel](../../support/support-guidelines.md#discord) 🚨. Remember, maintainers often juggle numerous responsibilities, so patience is appreciated🙇.
- 📢 **Escalate if Necessary**: If your requests continue to go unanswered, you may escalate the issue by posting a message in the [Autoware Discord channel](../../community/support/support-guidelines.md#discord) 🚨. Remember, maintainers often juggle numerous responsibilities, so patience is appreciated🙇.

### PR author is the only code owner

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/pull-request-guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use this workflow as a reference when you contribute to Autoware.

1. Create an issue.
- Discuss the approaches to the issue with maintainers.
- Confirm the [support guidelines](../../support/support-guidelines.md) before creating an issue.
- Confirm the [support guidelines](../../community/support/support-guidelines.md) before creating an issue.
- Follow the [discussion guidelines](../discussion-guidelines/index.md) when you discuss with other contributors.
2. Create a fork repository. (for the first time only)
3. Write code in your fork repository according to the approach agreed upon in the issue.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Autoware is the world’s leading open-source project dedicated to autonomous dr

**Datasets**: The [Datasets](datasets/index.md) pages are a crucial resource for anyone working with Autoware. Here, you'll find a collection of datasets that are compatible with Autoware, providing real-world scenarios and data to test and refine your autonomous driving solutions.

**Support**: As you dive deeper into Autoware, you might encounter challenges or have questions. The [Support](support/index.md) section is designed to assist you in these moments. This area includes FAQs, community forums, and contact information for getting help with Autoware. It's also a great place to connect with other Autoware users and contributors, sharing experiences and solutions.
**Support**: As you dive deeper into Autoware, you might encounter challenges or have questions. The [Support](community/support/index.md) section is designed to assist you in these moments. This area includes FAQs, community forums, and contact information for getting help with Autoware. It's also a great place to connect with other Autoware users and contributors, sharing experiences and solutions.

**Competitions**: The [Competitions](autoware-competitions/index.md) pages are where excitement meets innovation. Autoware regularly hosts or participates in various competitions and challenges, providing a platform for users to test their skills, showcase their work, and contribute to the community. These competitions range from local to global scale, offering opportunities for both beginners and experts to engage and excel. Stay updated with upcoming events and take part in the advancement of autonomous driving technologies.
**Competitions**: The [Competitions](community/autoware-competitions/index.md) pages are where excitement meets innovation. Autoware regularly hosts or participates in various competitions and challenges, providing a platform for users to test their skills, showcase their work, and contribute to the community. These competitions range from local to global scale, offering opportunities for both beginners and experts to engage and excel. Stay updated with upcoming events and take part in the advancement of autonomous driving technologies.

### Contribute and Collaborate

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/autoware/docker-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Open AD Kit provides different deployment options for Autoware, so that you can
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

If there is any build issue, refer to [Troubleshooting](../../support/troubleshooting/index.md#build-issues).
If there is any build issue, refer to [Troubleshooting](../../community/support/troubleshooting/index.md#build-issues).

### Update the Workspace

Expand Down
4 changes: 2 additions & 2 deletions docs/installation/autoware/source-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ sudo apt-get -y install git
./setup-dev-env.sh
```

If you encounter any build issues, please consult the [Troubleshooting](../../support/troubleshooting/index.md#build-issues) section for assistance.
If you encounter any build issues, please consult the [Troubleshooting](../../community/support/troubleshooting/index.md#build-issues) section for assistance.

!!! info

Expand Down Expand Up @@ -119,7 +119,7 @@ sudo apt-get -y install git
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

If there is any build issue, refer to [Troubleshooting](../../support/troubleshooting/index.md#build-issues).
If there is any build issue, refer to [Troubleshooting](../../community/support/troubleshooting/index.md#build-issues).

5. Follow the steps in [Network Configuration](../../installation/additional-settings-for-developers/network-configuration/index.md) before running Autoware.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For details of how to enable object detection and traffic light detection/classi
## Installing Autoware

There are five ways to set up Autoware. Choose one according to your preference. Autoware Core contains only the essential Autoware packages, and Autoware Universe contains the full Autoware stack.
For installation types, see the subsections below. If any issues occur during installation, refer to the [Support page](../support/index.md).
For installation types, see the subsections below. If any issues occur during installation, refer to the [Support page](../community/support/index.md).

- [Autoware Core Docker installation](autoware/core-docker-installation.md)
- [Autoware Core source installation](autoware/core-source-installation.md)
Expand Down
Loading