From 57aab7529cc0c5697fe6b57511c4221f3082d6e2 Mon Sep 17 00:00:00 2001 From: mackierx111 Date: Mon, 24 Oct 2022 17:06:32 +0900 Subject: [PATCH] update docs --- docs/DeveloperGuide/HowToContribution/index.md | 11 +++++++++++ docs/GettingStarted/QuickStartDemo/index.md | 2 +- docs/ProjectGuide/GitBranch/index.md | 4 ---- docs/index.md | 2 +- mkdocs.yml | 1 + 5 files changed, 14 insertions(+), 6 deletions(-) create mode 100644 docs/DeveloperGuide/HowToContribution/index.md diff --git a/docs/DeveloperGuide/HowToContribution/index.md b/docs/DeveloperGuide/HowToContribution/index.md new file mode 100644 index 000000000..6ddde5049 --- /dev/null +++ b/docs/DeveloperGuide/HowToContribution/index.md @@ -0,0 +1,11 @@ +# How to Contribution + +Everyone is welcome ! + +1. Create a derived branch (`feature/***`) from the `develop` branch. +2. Create a pull request for the `develop` branch. + +see also [AWSIM document - Git branch](https://tier4.github.io/AWSIM/ProjectGuide/GitBranch/) + +We recommend microsoft's [C# coding convention](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions?redirectedfrom=MSDN). +However, if the logic of the code is good, it does not matter if coding conventions are not followed. \ No newline at end of file diff --git a/docs/GettingStarted/QuickStartDemo/index.md b/docs/GettingStarted/QuickStartDemo/index.md index cd5756c57..4a04ede8d 100644 --- a/docs/GettingStarted/QuickStartDemo/index.md +++ b/docs/GettingStarted/QuickStartDemo/index.md @@ -92,7 +92,7 @@ fi 3. Download and Run AWSIM Demo binary. 1. Download `AWSIM_vXXX.zip` and Unzip. - [Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.0/AWSIM_v1.0.0.zip){.md-button .md-button--primary} + [Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.1/AWSIM_v1.0.1.zip){.md-button .md-button--primary} 2. Allow permission. diff --git a/docs/ProjectGuide/GitBranch/index.md b/docs/ProjectGuide/GitBranch/index.md index 07a55d5bc..6a3e8901d 100644 --- a/docs/ProjectGuide/GitBranch/index.md +++ b/docs/ProjectGuide/GitBranch/index.md @@ -1,9 +1,5 @@ # Git branch -!!! warning - - We have not started this branch operation yet, we will start it after the main branch is stable. - ## Branches |branch|explain| diff --git a/docs/index.md b/docs/index.md index 5bf36696f..574f0521c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,7 @@ AWSIM is the best scene simulator for [Autoware](https://github.com/autowarefoun ## Download demo binary -[Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.0/AWSIM_v1.0.0.zip){.md-button .md-button--primary} +[Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.1/AWSIM_v1.0.1.zip){.md-button .md-button--primary} Please try the AWSIM demo binary first! you can find a tutorial on the [Quick start demo](./GettingStarted/QuickStartDemo/index.md) page. diff --git a/mkdocs.yml b/mkdocs.yml index 7b54f4469..a26688c9f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,6 +55,7 @@ nav: - Add custom ROS2 msg type: Components/ROS2/AddCustomROS2MessageType/index.md - Developer guide: + - How to Contribution: DeveloperGuide/HowToContribution/index.md - Trouble shooting: DeveloperGuide/TroubleShooting/index.md - Documentation: DeveloperGuide/Documentation/index.md - License : DeveloperGuide/License/index.md