yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #10700 from HJianBo/update-docs 

Docs: fix invalid links in README files
This commit is contained in:
JianBo He 2023-05-15 19:57:20 +08:00 committed by GitHub
parent 6945f78f24 38fcb7a097
commit 857c7bb91d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_bridge_cassandra/README.md
View File

@ -11,7 +11,6 @@ The application is used to connect EMQX and Cassandra. User can create a rule
and easily ingest IoT data into Cassandra by leveraging and easily ingest IoT data into Cassandra by leveraging
[EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html). [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html).
<!---
# Documentation # Documentation
@ -20,7 +19,6 @@ and easily ingest IoT data into Cassandra by leveraging
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)
for the EMQX rules engine introduction. for the EMQX rules engine introduction.
--->
# HTTP APIs # HTTP APIs

2
apps/emqx_bridge_dynamo/README.md
View File

@ -1,6 +1,6 @@
# EMQX DynamoDB Bridge # EMQX DynamoDB Bridge
[Dynamodb](https://aws.amazon.com/dynamodb/) is a high-performance NoSQL database [DynamoDB](https://aws.amazon.com/dynamodb/) is a high-performance NoSQL database
service provided by Amazon that's designed for scalability and low-latency access service provided by Amazon that's designed for scalability and low-latency access
to structured data. to structured data.

2
apps/emqx_bridge_gcp_pubsub/README.md
View File

@ -10,7 +10,7 @@ User can create a rule and easily ingest IoT data into GCP Pub/Sub by leveraging
# Documentation # Documentation
- Refer to [Ingest data into GCP Pub/Sub](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-gcp-pubsub.html) - Refer to [Ingest Data into GCP Pub/Sub](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-gcp-pubsub.html)
for how to use EMQX dashboard to ingest IoT data into GCP Pub/Sub. for how to use EMQX dashboard to ingest IoT data into GCP Pub/Sub.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

2
apps/emqx_bridge_influxdb/README.md
View File

@ -15,7 +15,7 @@ easily ingest IoT data into InfluxDB by leveraging
# Documentation # Documentation
- Refer to [Ingest data into InfluxDB](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-influxdb.html) - Refer to [Ingest Data into InfluxDB](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-influxdb.html)
for how to use EMQX dashboard to ingest IoT data into InfluxDB. for how to use EMQX dashboard to ingest IoT data into InfluxDB.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

4
apps/emqx_bridge_iotdb/README.md
View File

@ -12,13 +12,15 @@ It implements the connection management and interaction without need for a
For more information on Apache IoTDB, please see its [official For more information on Apache IoTDB, please see its [official
site](https://iotdb.apache.org/). site](https://iotdb.apache.org/).
<!---
# Configurations # Configurations
Please see [our official Please see [our official
documentation](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-iotdb.html) documentation](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-iotdb.html)
for more detailed info. for more detailed info.
--->
# Contributing - [Mandatory] # Contributing
Please see our [contributing.md](../../CONTRIBUTING.md). Please see our [contributing.md](../../CONTRIBUTING.md).
# License # License

2
apps/emqx_bridge_kafka/README.md
View File

@ -16,7 +16,7 @@ For more information about Apache Kafka, please see its [official site](https://
# Configurations # Configurations
Please see [Ingest data into Kafka](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-kafka.html) for more detailed info. Please see [Ingest Data into Kafka](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-kafka.html) for more detailed info.
# Contributing # Contributing

2
apps/emqx_bridge_mongodb/README.md
View File

@ -13,7 +13,7 @@ User can create a rule and easily ingest IoT data into MongoDB by leveraging
# Documentation # Documentation
- Refer to [Ingest data into MongoDB](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-mongodb.html) - Refer to [Ingest Data into MongoDB](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-mongodb.html)
for how to use EMQX dashboard to ingest IoT data into MongoDB. for how to use EMQX dashboard to ingest IoT data into MongoDB.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

2
apps/emqx_bridge_mysql/README.md
View File

@ -10,7 +10,7 @@ User can create a rule and easily ingest IoT data into MySQL by leveraging
# Documentation # Documentation
- Refer to [Ingest data into MySQL](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-mysql.html) - Refer to [Ingest Data into MySQL](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-mysql.html)
for how to use EMQX dashboard to ingest IoT data into MySQL. for how to use EMQX dashboard to ingest IoT data into MySQL.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

4
apps/emqx_bridge_pgsql/README.md
View File

@ -1,6 +1,6 @@
# EMQX PostgreSQL Bridge # EMQX PostgreSQL Bridge
[PostgreSQL](https://github.com/PostgreSQL/PostgreSQL) is an open-source relational [PostgreSQL](https://www.postgresql.org/) is an open-source relational
database management system (RDBMS) that uses and extends the SQL language. database management system (RDBMS) that uses and extends the SQL language.
It is known for its reliability, data integrity, and advanced features such as It is known for its reliability, data integrity, and advanced features such as
support for JSON, XML, and other data formats. support for JSON, XML, and other data formats.
@ -12,7 +12,7 @@ User can create a rule and easily ingest IoT data into PostgreSQL by leveraging
# Documentation # Documentation
- Refer to [Ingest data into PostgreSQL](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-pgsql.html) - Refer to [Ingest Data into PostgreSQL](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-pgsql.html)
for how to use EMQX dashboard to ingest IoT data into PostgreSQL. for how to use EMQX dashboard to ingest IoT data into PostgreSQL.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

2
apps/emqx_bridge_pulsar/README.md
View File

@ -15,11 +15,13 @@ used by authentication and authorization applications.
For more information on Apache Pulsar, please see its [official For more information on Apache Pulsar, please see its [official
site](https://pulsar.apache.org/). site](https://pulsar.apache.org/).
<!---
# Configurations # Configurations
Please see [our official Please see [our official
documentation](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-pulsar.html) documentation](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-pulsar.html)
for more detailed info. for more detailed info.
--->
# Contributing # Contributing

2
apps/emqx_bridge_rabbitmq/README.md
View File

@ -21,8 +21,10 @@ and easily ingest IoT data into RabbitMQ by leveraging
# Documentation # Documentation
<!---
- Refer to the [RabbitMQ bridge documentation](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-rabbitmq.html) - Refer to the [RabbitMQ bridge documentation](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-rabbitmq.html)
for how to use EMQX dashboard to ingest IoT data into RabbitMQ. for how to use EMQX dashboard to ingest IoT data into RabbitMQ.
--->
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)
for an introduction to the EMQX rules engine. for an introduction to the EMQX rules engine.

2
apps/emqx_bridge_redis/README.md
View File

@ -11,7 +11,7 @@ User can create a rule and easily ingest IoT data into Redis by leveraging
# Documentation # Documentation
- Refer to [Ingest data into Redis](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-redis.html) - Refer to [Ingest Data into Redis](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-redis.html)
for how to use EMQX dashboard to ingest IoT data into Redis. for how to use EMQX dashboard to ingest IoT data into Redis.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

2
apps/emqx_bridge_rocketmq/README.md
View File

@ -11,7 +11,7 @@ User can create a rule and easily ingest IoT data into RocketMQ by leveraging
# Documentation # Documentation
- Refer to [Ingest data into RocketMQ](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-rocketmq.html) - Refer to [Ingest Data into RocketMQ](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-rocketmq.html)
for how to use EMQX dashboard to ingest IoT data into RocketMQ. for how to use EMQX dashboard to ingest IoT data into RocketMQ.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

2
apps/emqx_bridge_sqlserver/README.md
View File

@ -16,7 +16,7 @@ For more information about Microsoft SQL Server, please see the [official site](
# Configurations # Configurations
Please see [Ingest data into SQL Server](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-sqlserver.html) for more detailed information. Please see [Ingest Data into SQL Server](https://www.emqx.io/docs/en/v5.0/data-integration/data-bridge-sqlserver.html) for more detailed information.
# HTTP APIs # HTTP APIs

2
apps/emqx_bridge_tdengine/README.md
View File

@ -13,7 +13,7 @@ User can create a rule and easily ingest IoT data into TDEngine by leveraging
# Documentation # Documentation
- Refer to [Ingest data into TDEngine](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-tdengine.html) - Refer to [Ingest Data into TDEngine](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridge-tdengine.html)
for how to use EMQX dashboard to ingest IoT data into TDEngine. for how to use EMQX dashboard to ingest IoT data into TDEngine.
- Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html) - Refer to [EMQX Rules](https://docs.emqx.com/en/enterprise/v5.0/data-integration/rules.html)

4
apps/emqx_gateway/README.md
View File

@ -19,8 +19,8 @@ More introduction: [Extended Protocol Gateway](https://www.emqx.io/docs/en/v5.0/
## Usage ## Usage
This application is just a Framework, we provide some standard implementations, This application is just a Framework, we provide some standard implementations,
such as [Stomp](../emqx_stomp/README.md), [MQTT-SN](../emqx_mqttsn/README.md), such as [Stomp](../emqx_gateway_stomp/README.md), [MQTT-SN](../emqx_gateway_mqttsn/README.md),
[CoAP](../emqx_coap/README.md) and [LwM2M](../emqx_lwm2m/README.md) gateway. [CoAP](../emqx_gateway_coap/README.md) and [LwM2M](../emqx_gateway_lwm2m/README.md) gateway.
These applications are all packaged by default in the EMQX distribution. If you These applications are all packaged by default in the EMQX distribution. If you
need to start a certain gateway, you only need to enable it via need to start a certain gateway, you only need to enable it via

4
apps/emqx_gateway_exproto/README.md
View File

@ -7,10 +7,6 @@ The `emqx_exproto` extremely enhance the extensibility for EMQX. It allow using
- [x] Based on gRPC, it brings a very wide range of applicability - [x] Based on gRPC, it brings a very wide range of applicability
- [x] Allows you to use the return value to extend emqx behavior. - [x] Allows you to use the return value to extend emqx behavior.
## Architecture
![EMQX ExProto Arch](./docs/images/exproto-arch.jpg)
## Usage ## Usage
### gRPC service ### gRPC service

2
apps/emqx_rule_engine/README.md
View File

@ -1,5 +1,5 @@
# Emqx Rule Engine # EMQX Rule Engine
The rule engine's goal is to provide a simple and flexible way to transform and The rule engine's goal is to provide a simple and flexible way to transform and
reroute the messages coming to the EMQX broker. For example, one message reroute the messages coming to the EMQX broker. For example, one message