You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by aa...@apache.org on 2022/09/04 12:10:43 UTC
[rocketmq-clients] branch fix_docs_lint updated (b9f9311 -> 4932a59)
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a change to branch fix_docs_lint
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
discard b9f9311 WIP
new 4932a59 WIP
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (b9f9311)
\
N -- N -- N refs/heads/fix_docs_lint (4932a59)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
[rocketmq-clients] 01/01: WIP
Posted by aa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch fix_docs_lint
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
commit 4932a59d8d4c9596c7e77336ac2fb83f49f997ed
Author: Aaron Ai <ya...@gmail.com>
AuthorDate: Sun Sep 4 19:24:55 2022 +0800
WIP
---
.github/workflows/markdown_lint.yml | 2 +-
README.md | 4 ++++
cpp/docs/gtest.md | 14 +++++++++-----
cpp/docs/test_coverage.md | 8 ++++++--
csharp/README.md | 34 +++++++++++++---------------------
docs/observability.md | 2 +-
docs/workflow.md | 6 ++----
golang/README.md | 21 ++++++---------------
style/markdown/config.yml | 3 ++-
9 files changed, 44 insertions(+), 50 deletions(-)
diff --git a/.github/workflows/markdown_lint.yml b/.github/workflows/markdown_lint.yml
index 915a939..bda32f7 100644
--- a/.github/workflows/markdown_lint.yml
+++ b/.github/workflows/markdown_lint.yml
@@ -14,4 +14,4 @@ jobs:
- name: Install mardkdownlint
run: npm install -g markdownlint-cli
- name: Run markdownlint
- run: markdownlint -c ./style/markdown/config.yml -i ./cpp/third_party **/*.md
+ run: markdownlint -c ./style/markdown/config.yml -i ./cpp/third_party -i ./rust/src/pb/README.md **/*.md
diff --git a/README.md b/README.md
index aee60ef..12842c2 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,10 @@ Provide cloud-native and robust solutions for Java, C++, C#, Golang, Rust and al
* [RIP-37: New and Unified APIs](https://shimo.im/docs/m5kv92OeRRU8olqX): RocketMQ proposal of new and unified APIs crossing different languages.
* [RIP-39: Support gRPC protocol](https://shimo.im/docs/gXqmeEPYgdUw5bqo): RocketMQ proposal of gRPC protocol support.
+## Contributing
+
+Similar to other projects of Apache RocketMQ, any attempt to make this project better is welcome, including but not limited to filing a bug report/correcting type error/document writing to complete feature implementation. Do not hesitate to make a pull request if this project catches your attention.
+
## License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
diff --git a/cpp/docs/gtest.md b/cpp/docs/gtest.md
index 0c40d9d..3fc97a1 100644
--- a/cpp/docs/gtest.md
+++ b/cpp/docs/gtest.md
@@ -1,8 +1,12 @@
+# GoogleTest Quickstart
+
## Run a single test case
+
1. Get all test cases by running tests with --gtest_list_tests
-1. Parse this data into your GUI
-1. Select test cases you want ro run
-1. Run test executable with option --gtest_filter=
-
+2. Parse this data into your GUI
+3. Select test cases you want ro run
+4. Run test executable with option --gtest_filter=
+
## Run tests multiple times
-bazel test --runs_per_test=10 //...
\ No newline at end of file
+
+bazel test --runs_per_test=10 //...
diff --git a/cpp/docs/test_coverage.md b/cpp/docs/test_coverage.md
index 2c836a9..e0795e5 100644
--- a/cpp/docs/test_coverage.md
+++ b/cpp/docs/test_coverage.md
@@ -1,4 +1,7 @@
-### Generate Coverage Data
+# Test Covergge Report
+
+## Generate Coverage Data
+
```text
bazel coverage -s \
--instrument_test_targets \
@@ -8,7 +11,8 @@
//src/test/...
```
-### Generate HTML pages
+## Generate HTML pages
+
```text
genhtml bazel-out/_coverage/_coverage_report.dat \
--output-directory coverage_html
diff --git a/csharp/README.md b/csharp/README.md
index bdc2bba..33589d2 100644
--- a/csharp/README.md
+++ b/csharp/README.md
@@ -1,44 +1,36 @@
-[](https://github.com/lizhanhui/rocketmq-client-csharp/actions/workflows/main.yml)
+# The C# Implementation
-Introduction
---------------
-Project rocketmq-client-csharp is targeted to implement C# binding in native C# code. At the current moment, it is still a work-in-progress project. Do not use it in production till it grows mature enough.
+## Introduction
+
+This is still a work-in-progress project. Do not use it in production till it grows mature enough.
+
+## Architecture
-Architecture
---------------
Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-dotnet](https://github.com/grpc/grpc-dotnet), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission.
+## How to build
-How to build
------------------
Layout of this project roughly follows [this guide](https://docs.microsoft.com/en-us/dotnet/core/tutorials/library-with-visual-studio-code?pivots=dotnet-5-0). The solution contains a class library, a unit test module and an example console module.
1. Install dotnet tool chains following instructions [here](https://dotnet.microsoft.com/en-us/download);
2. Visual Studio Code with official C# plugin is used during development;
Assuming you are at the home of this repository,
-#### Build
+
+### Build
```sh
dotnet build
```
-#### Run Unit Tests
+### Run Unit Tests
+
```sh
dotnet test -l "console;verbosity=detailed"
```
-#### Run Examples
+### Run Examples
+
```sh
dotnet run -p examples
```
-
-License
-------------------
-This project follows [Apache License Version 2.0](./LICENSE).
-
-How to contribute
-------------------
-Similar to other Apache RocketMQ projects, we welcome contributions in various ways, from filing a bug report, correcting type error, document writing to complete feature implementation. Any attempt to make this project better is welcome.
-
-If this project catches your attention, do not hesitate to make a pull request.
\ No newline at end of file
diff --git a/docs/observability.md b/docs/observability.md
index 136c055..55a7bf5 100644
--- a/docs/observability.md
+++ b/docs/observability.md
@@ -12,4 +12,4 @@
| -------- | ----------------------------------------- |
| CPP | `$HOME/logs/rocketmq/client.log` |
| C# | `$HOME/logs/rocketmq/rocketmq-client.log` |
-| Java | `$HOME/logs/rocketmq/rocketmq-client.log` |
\ No newline at end of file
+| Java | `$HOME/logs/rocketmq/rocketmq-client.log` |
diff --git a/docs/workflow.md b/docs/workflow.md
index 9344f41..7cfa614 100644
--- a/docs/workflow.md
+++ b/docs/workflow.md
@@ -11,9 +11,7 @@ Different from previous clients, the new version adds some preparations during t
Failure of any preparation will result in the failure of client startup.
-<div align="center">
-<img src="./artwork/client_startup_process.png" width="80%">
-</div>
+
In details, the **server-client telemetry** provides a channel to upload the local settings and to overwrite the client settings.
@@ -84,4 +82,4 @@ For TRANSACTIONAL messages, the publishing will not be retried if failure is enc
<div align="center">
<img src="./artwork/message_receiving_and_process_in_simple_consumer.png" width="50%">
-</div>
\ No newline at end of file
+</div>
diff --git a/golang/README.md b/golang/README.md
index e1ed513..ace88de 100644
--- a/golang/README.md
+++ b/golang/README.md
@@ -1,16 +1,14 @@
-Introduction
---------------
+# The Golang Implementation
+
Project github.com/apache/rocketmq-clients/golang is targeted to implement with golang. At the current moment, it is still a work-in-progress project. Do not use it in production till it grows mature enough.
-Architecture
---------------
-We build the following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission.
+## Architecture
+We build the following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission.
-How to use
------------------
+## Quick Start
-#### Installation
+### Installation
With [Go modules](https://go.dev/doc/go1.11#modules)(Go 1.11+), simply add the following import to your code, and then `go [build|run|test]` will automatically fetch the necessary dependencies.
@@ -22,10 +20,3 @@ Otherwise, to install the `golang` package, run the following command:
```console
$ go get -u github.com/apache/rocketmq-clients/golang
```
-
-
-How to contribute
-------------------
-Similar to other Apache RocketMQ projects, we welcome contributions in various ways, from filing a bug report, correcting type error, document writing to complete feature implementation. Any attempt to make this project better is welcome.
-
-If this project catches your attention, do not hesitate to make a pull request.
\ No newline at end of file
diff --git a/style/markdown/config.yml b/style/markdown/config.yml
index a79f9ac..4b12d2f 100644
--- a/style/markdown/config.yml
+++ b/style/markdown/config.yml
@@ -99,7 +99,8 @@ MD031: true
MD032: true
# Inline HTML <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033>
-MD033: true
+MD033:
+ allowed_elements: ["div", "img"]
# Bare URL used <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034>
MD034: true