Merge pull request #5 from AutoMQ/yifei_docs

feat: Yifei docs

Author: Kris20030907

README.md

@@ -5,18 +5,18 @@ This module is designed for deploying the AutoMQ BYOC (Bring Your Own Cloud) env
 
 Upon completion of the installation, the module will output the endpoint of the AutoMQ BYOC environment along with the initial username and password. Users can manage the resources within the environment through the following two methods:
 
-- **Using the Web UI to manage resources**: This method allows users to manage instances, topics, ACLs, and other resources through a web-based interface.
+- **Using the Web UI to manage resources**: This method allows users to manage instances, topics, ACLs, and other resources through a web-ui.
 - **Using Terraform to manage resources**: This method requires users to access the AutoMQ BYOC environment via a web browser for the first time to create a Service Account. Subsequently, users can manage resources within the environment using the Service Account's Access Key and the AutoMQ Terraform Provider.
 
 For managing instances, topics, and other resources within the AutoMQ BYOC environment using the AutoMQ Terraform Provider, please refer to the [documentation](https://docs.automq.com/automq-cloud/manage-identities-and-access).
 
 # Module Usage
 Use this module to install the AutoMQ BYOC environment, supporting two modes:
 
-- **Create a new VPC and install**: Recommended only for POC or other testing scenarios. In this mode, the user only needs to specify the region, and resources including VPC, Endpoint, Security Group, S3 Bucket, etc., will be created. After testing, all resources can be destroyed with one click.
-- **Install using an existing VPC**: Recommended for production environments. In this mode, the user needs to provide a VPC, subnet, and S3 Bucket that meet the requirements. AutoMQ will deploy the BYOC environment console to the user-specified subnet.
+- **Create a new VPC**: Recommended only for POC or other testing scenarios. In this mode, the user only needs to specify the region, and resources including VPC, Endpoint, Security Group, S3 Bucket, etc., will be created. After testing, all resources can be destroyed with one click.
+- **Using an existing VPC**: Recommended for production environments. In this mode, the user needs to provide a VPC, subnet, and S3 Bucket that meet the requirements. AutoMQ will deploy the BYOC environment console to the user-specified subnet.
 
-## Create a new VPC and install
+## Create a new VPC
 
 ```terraform
 module "automq_byoc" {
@@ -30,7 +30,7 @@ module "automq_byoc" {
 }
 ```
 
-## Install using an existing VPC
+## Using an existing VPC
 
 To install the AutoMQ BYOC environment using an existing VPC, ensure your existing VPC meets the necessary requirements. You can find the detailed requirements in the [doc](https://docs.automq.com/zh/automq-cloud/getting-started/create-byoc-environment/aws/step-1-installing-env-with-ami#%E6%AD%A5%E9%AA%A4-3%E5%90%AF%E5%8A%A8-ec2-%E5%AE%9E%E4%BE%8B%E5%AE%89%E8%A3%85%E7%8E%AF%E5%A2%83).
 
@@ -56,6 +56,16 @@ module "automq_byoc" {
 }
 ```
 
+# Helpful Links/Information
+
+* [Report Bugs](https://github.com/AutoMQ/terraform-aws-automq-byoc-environmet/issues)
+
+* [Documents](https://docs.automq.com/automq-cloud/overview)
+
+* [Request Features](https://automq66.feishu.cn/share/base/form/shrcn7qXbb5aKiYbKqbJtPlGWXc)
+
+
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 

README.tmpl.md

@@ -1,21 +1,22 @@
 # AWS AutoMQ BYOC Environment Terrafrom module
+![Preview](https://img.shields.io/badge/Lifecycle_Stage-Preview-blue?style=flat&logoColor=8A3BE2&labelColor=rgba)
 
 This module is designed for deploying the AutoMQ BYOC (Bring Your Own Cloud) environment using the AWS Provider within an AWS cloud environment.
 
 Upon completion of the installation, the module will output the endpoint of the AutoMQ BYOC environment along with the initial username and password. Users can manage the resources within the environment through the following two methods:
 
-- **Using the Web UI to manage resources**: This method allows users to manage instances, topics, ACLs, and other resources through a web-based interface.
+- **Using the Web UI to manage resources**: This method allows users to manage instances, topics, ACLs, and other resources through a web-ui.
 - **Using Terraform to manage resources**: This method requires users to access the AutoMQ BYOC environment via a web browser for the first time to create a Service Account. Subsequently, users can manage resources within the environment using the Service Account's Access Key and the AutoMQ Terraform Provider.
 
 For managing instances, topics, and other resources within the AutoMQ BYOC environment using the AutoMQ Terraform Provider, please refer to the [documentation](https://docs.automq.com/automq-cloud/manage-identities-and-access).
 
 # Module Usage
 Use this module to install the AutoMQ BYOC environment, supporting two modes:
 
-- **Create a new VPC and install**: Recommended only for POC or other testing scenarios. In this mode, the user only needs to specify the region, and resources including VPC, Endpoint, Security Group, S3 Bucket, etc., will be created. After testing, all resources can be destroyed with one click.
-- **Install using an existing VPC**: Recommended for production environments. In this mode, the user needs to provide a VPC, subnet, and S3 Bucket that meet the requirements. AutoMQ will deploy the BYOC environment console to the user-specified subnet.
+- **Create a new VPC**: Recommended only for POC or other testing scenarios. In this mode, the user only needs to specify the region, and resources including VPC, Endpoint, Security Group, S3 Bucket, etc., will be created. After testing, all resources can be destroyed with one click.
+- **Using an existing VPC**: Recommended for production environments. In this mode, the user needs to provide a VPC, subnet, and S3 Bucket that meet the requirements. AutoMQ will deploy the BYOC environment console to the user-specified subnet.
 
-## Create a new VPC and install
+## Create a new VPC
 
 ```terraform
 module "automq_byoc" {
@@ -29,7 +30,7 @@ module "automq_byoc" {
 }
 ```
 
-## Install using an existing VPC
+## Using an existing VPC
 
 To install the AutoMQ BYOC environment using an existing VPC, ensure your existing VPC meets the necessary requirements. You can find the detailed requirements in the [doc](https://docs.automq.com/zh/automq-cloud/getting-started/create-byoc-environment/aws/step-1-installing-env-with-ami#%E6%AD%A5%E9%AA%A4-3%E5%90%AF%E5%8A%A8-ec2-%E5%AE%9E%E4%BE%8B%E5%AE%89%E8%A3%85%E7%8E%AF%E5%A2%83).
 
@@ -53,4 +54,12 @@ module "automq_byoc" {
   automq_byoc_env_console_public_subnet_id = "subnet-09500xxxxxb6fd28"  
   
 }
-```
+```
+
+# Helpful Links/Information
+
+* [Report Bugs](https://github.com/AutoMQ/terraform-aws-automq-byoc-environmet/issues)
+
+* [Documents](https://docs.automq.com/automq-cloud/overview)
+
+* [Request Features](https://automq66.feishu.cn/share/base/form/shrcn7qXbb5aKiYbKqbJtPlGWXc)