You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by GitBox <gi...@apache.org> on 2022/03/29 06:15:11 UTC
[GitHub] [shardingsphere] lanchengx opened a new issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
lanchengx opened a new issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455
Hi community,
This issue is for https://github.com/apache/shardingsphere/discussions/12683#discussioncomment-2139441
### Background
DistSQL（Distributed SQL）is Apache ShardingSphere specific SQL.
In documentation we usually use all uppercase words for grammar keywords and camel case for grammar variables.
For example, in the syntax `ADD RESOURCE dataSource`, `ADD` and `RESOURCE` are syntax keywords, `dataSource` is variable
### Aim
Modify grammar keywords in documents to uppercase.
The document path is: docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/ral/_index.en.md
### How to
1. Open the grammar definition file
2. Find the column that needs to be modified. The `Statement` column and `Example` in the table are the columns that need to be modified
3. Identify syntax keywords.
- Determined by the grammar definition file.
The grammar definition file is as follows
- shardingsphere-distsql/shardingsphere-distsql-parser/src/main/antlr4/imports/RALStatement.g4
- shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-distsql/shardingsphere-readwrite-splitting-distsql-parser/src/main/antlr4/imports/readwrite-splitting/RALStatement.g4
- shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-distsql/shardingsphere-sharding-distsql-parser/src/main/antlr4/imports/sharding/RALStatement.g4
- shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-distsql/shardingsphere-sharding-distsql-parser/src/main/antlr4/imports/scaling/RALStatement.g4
### Example
Take modifying `set readwrite_splitting hint source = [auto/write]` as an example.
Search `set readwrite_splitting hint source` to determine the file where the grammar is located is `shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-distsql/shardingsphere-readwrite-splitting-distsql-parser/src/main/antlr4/imports/ readwrite-splitting/RALStatement.g4`.
The syntax is defined as `SET READWRITE_SPLITTING HINT SOURCE EQ sourceValue` .
So `set readwrite_splitting hint source = [auto/write]` should be changed to `SET READWRITE_SPLITTING HINT SOURCE = [auto/write]`
### Example FYI
[RAL::Global Rule](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/#global-rule)
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082849825
Plz review the PR I've opened for the issue. If this one is correct, I'll do the same for `_index.cn.md` file
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082716274
> If you find it difficult, you can also just adjust `_index.en.md`
No if its just those columns in `_index.cn.md` which need to be modified, I'll do it.
Thanks!
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] lanchengx commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
lanchengx commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1083848655
@ritikBhandari it is wanted. I will merge your other PR soon
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1083989602
> @ritikBhandari it is wanted. I will merge your other PR soon
Thank you:)
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082702194
I guess `cn` means Chinese. Right?
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] lanchengx commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
lanchengx commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1081499101
@ritikBhandari Welcome
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] lanchengx commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
lanchengx commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082708407
> `_index.cn.md` is also to be modified?
Yeah, it needs to be modified.
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1081451235
Hi,
Can I work on this?
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] KALYAN393 commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
KALYAN393 commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1081742937
Hi, as this is my first contribution so i think that this issue is good to start, kindly allow me to work on this issue if possible.
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] terrymanu closed issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
terrymanu closed issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] lanchengx commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
lanchengx commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082713211
Like `_index.en.md`, only need to adjust the `语句` and `示例 ` columns, the Chinese part does not need to be modified
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] lanchengx commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
lanchengx commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082714471
If you find it difficult, you can also just adjust `_index.en.md`
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082709179
But most of the content is in Chinese ig. Is there any catch to modify it or manual translation?
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082701929
`_index.cn.md` is also to be modified?
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] lanchengx commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
lanchengx commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1082551710
@KALYAN393 Sorry, already assigned to @ritikBhandari .
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] ritikBhandari commented on issue #16455: [OpenForce 2022] Modify capitalization of keywords in RAL grammar documents
Posted by GitBox <gi...@apache.org>.
ritikBhandari commented on issue #16455:
URL: https://github.com/apache/shardingsphere/issues/16455#issuecomment-1083452366
@terrymanu I have resolved the issue for _index.cn.md as well. You can consider it if you want.
--
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: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org