You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fluss.apache.org by "ZmmBigdata (via GitHub)" <gi...@apache.org> on 2025/08/05 01:23:18 UTC
[PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
ZmmBigdata opened a new pull request, #1474:
URL: https://github.com/apache/fluss/pull/1474
### Purpose
Linked issue: close #xxx
**What is the purpose of the change**:
fix typos, grammar, casing, and spacing in multiple documents
### Brief change log
**Please describe the changes**:
1. fix typos, grammar, casing, and spacing in multiple documents
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
Posted by "polyzos (via GitHub)" <gi...@apache.org>.
polyzos commented on code in PR #1474:
URL: https://github.com/apache/fluss/pull/1474#discussion_r2256051714
##########
website/docs/maintenance/configuration.md:
##########
@@ -163,7 +163,7 @@ during the Fluss cluster working.
| Option | Type | Default | Description |
|-----------------|------|---------|---------------------------------------------------------------------------------------------------------------------------|
-| datalake.format | ENUM | (None) | The datalake format used by of Fluss to be as lakehouse storage, such as Paimon, Iceberg, Hudi. Now, only support Paimon. |
+| datalake.format | Enum | (None) | The datalake format used by of Fluss to be as lakehouse storage, such as Paimon, Iceberg, Hudi. Now, only support Paimon. |
Review Comment:
its minor really, because the datatype is ENUM, but then again all the others indeed follow a similar pattern
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
Posted by "ZmmBigdata (via GitHub)" <gi...@apache.org>.
ZmmBigdata commented on code in PR #1474:
URL: https://github.com/apache/fluss/pull/1474#discussion_r2255699916
##########
website/docs/maintenance/configuration.md:
##########
@@ -163,7 +163,7 @@ during the Fluss cluster working.
| Option | Type | Default | Description |
|-----------------|------|---------|---------------------------------------------------------------------------------------------------------------------------|
-| datalake.format | ENUM | (None) | The datalake format used by of Fluss to be as lakehouse storage, such as Paimon, Iceberg, Hudi. Now, only support Paimon. |
+| datalake.format | Enum | (None) | The datalake format used by of Fluss to be as lakehouse storage, such as Paimon, Iceberg, Hudi. Now, only support Paimon. |
Review Comment:
> I think ENUM is ok here
Inconsistency in context，ENUM and Enum
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
Posted by "polyzos (via GitHub)" <gi...@apache.org>.
polyzos merged PR #1474:
URL: https://github.com/apache/fluss/pull/1474
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
Posted by "polyzos (via GitHub)" <gi...@apache.org>.
polyzos commented on PR #1474:
URL: https://github.com/apache/fluss/pull/1474#issuecomment-3154314891
@ZmmBigdata Thank you for these contributions.. i left some minor comments
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
Posted by "ZmmBigdata (via GitHub)" <gi...@apache.org>.
ZmmBigdata commented on code in PR #1474:
URL: https://github.com/apache/fluss/pull/1474#discussion_r2255701743
##########
website/docs/security/authentication.md:
##########
@@ -86,10 +86,10 @@ Fluss supports custom authentication logic through its plugin architecture.
Steps to implement a custom authenticator:
1. **Implement AuthenticationPlugin Interfaces**:
Implement `ClientAuthenticationPlugin` for client-side logic and implement `ServerAuthenticationPlugin` for server-side logic.
-2. **Server-side Plugin Installation**:
+2. **Server-Side Plugin Installation**:
Build the plugin as a standalone JAR and copy it to the Fluss server’s plugin directory: `<FLUSS_HOME>/plugins/<custom_auth_plugin>/`. The server will automatically load the plugin at startup.
-3. **Client-side Plugin Packaging** :
+3. **Client-Side Plugin Packaging** :
To enable plugin functionality on the client side, include the plugin JAR in your application’s classpath. This allows the Fluss client to auto-discover the plugin during runtime.
-4. **Configure the desired protocol**:
+4. **Configure the Desired Protocol**:
Review Comment:
> i dont think this requires changing
Shouldn't the first letter of each word in the title be capitalized?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs]fix typos, grammar, casing, and spacing in multiple documents [fluss]
Posted by "polyzos (via GitHub)" <gi...@apache.org>.
polyzos commented on code in PR #1474:
URL: https://github.com/apache/fluss/pull/1474#discussion_r2253708015
##########
website/docs/security/authentication.md:
##########
@@ -86,10 +86,10 @@ Fluss supports custom authentication logic through its plugin architecture.
Steps to implement a custom authenticator:
1. **Implement AuthenticationPlugin Interfaces**:
Implement `ClientAuthenticationPlugin` for client-side logic and implement `ServerAuthenticationPlugin` for server-side logic.
-2. **Server-side Plugin Installation**:
+2. **Server-Side Plugin Installation**:
Build the plugin as a standalone JAR and copy it to the Fluss server’s plugin directory: `<FLUSS_HOME>/plugins/<custom_auth_plugin>/`. The server will automatically load the plugin at startup.
-3. **Client-side Plugin Packaging** :
+3. **Client-Side Plugin Packaging** :
To enable plugin functionality on the client side, include the plugin JAR in your application’s classpath. This allows the Fluss client to auto-discover the plugin during runtime.
-4. **Configure the desired protocol**:
+4. **Configure the Desired Protocol**:
Review Comment:
i dont think this requires changing
##########
website/docs/maintenance/configuration.md:
##########
@@ -163,7 +163,7 @@ during the Fluss cluster working.
| Option | Type | Default | Description |
|-----------------|------|---------|---------------------------------------------------------------------------------------------------------------------------|
-| datalake.format | ENUM | (None) | The datalake format used by of Fluss to be as lakehouse storage, such as Paimon, Iceberg, Hudi. Now, only support Paimon. |
+| datalake.format | Enum | (None) | The datalake format used by of Fluss to be as lakehouse storage, such as Paimon, Iceberg, Hudi. Now, only support Paimon. |
Review Comment:
I think ENUM is ok here
##########
website/docs/security/authorization.md:
##########
@@ -195,9 +195,9 @@ CALL [catalog].sys.drop_acl(
Fluss supports custom authorization logic through its plugin architecture.
-Steps to implement a custom authorization logic:
+Steps to Implement a Custom Authorization Logic:
1. **Implement `AuthorizationPlugin` Interfaces**.
-2. **Server-side Plugin Installation**:
+2. **Server-Side Plugin Installation**:
Build the plugin as a standalone JAR and copy it to the Fluss server’s plugin directory: `<FLUSS_HOME>/plugins/<custom_auth_plugin>/`. The server will automatically load the plugin at startup.
-3. **Configure the desired protocol**: Set `com.alibaba.fluss.server.authorizer.AuthorizationPlugin.identifier` as the value of `authorizer.type` in the Fluss server configuration file.
+3. **Configure the Desired Protocol**: Set `com.alibaba.fluss.server.authorizer.AuthorizationPlugin.identifier` as the value of `authorizer.type` in the Fluss server configuration file.
Review Comment:
ditto
##########
website/docs/maintenance/observability/monitor-metrics.md:
##########
@@ -745,7 +745,7 @@ When using Flink to read and write, Fluss has implemented some key standard Flin
to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics).
Flink source / sink metrics implemented are listed here.
-How to use flink metrics, you can see [flink metrics](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/ops/metrics/#system-metrics) for more details.
+How to Use Flink Metrics, you can see [Flink Metrics](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/ops/metrics/#system-metrics) for more details.
Review Comment:
leave it as 'use'
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org