RaigorJiang opened a new issue #12557:
URL: https://github.com/apache/shardingsphere/issues/12557


   
   ### Background
   
   Currently, the directory structure of examples looks like this:
   
   
   ```
   .
   ├── docker
   │   ├── shardingsphere-jdbc
   │   └── shardingsphere-proxy
   ├── example-core
   ├── shardingsphere-jdbc-example
   │   ├── cluster-mode-example
   │   ├── extension-example
   │   ├── other-feature-example
   │   │   ├── encrypt-example
   │   │   ├── future-shadow-example
   │   │   ├── hint-example
   │   │   ├── shadow-example
   │   ├── sharding-example
   │   └── transaction-example
   ├── shardingsphere-parser-example
   ├── shardingsphere-proxy-example
   └── src
   ```
   
   Notice:
   The shadow feature is being refactored, so `shadow-example` and 
`future-shadow-example` exist at the same time and will be merged in the future.
   
   
   
   ### problems
   
   There are some problems:
   
   #### docker
   - In the `docker/shardingsphere-jdbc` directory, only an image with a 
database and registry center is actually created, which has nothing to do with 
shardingsphere-jdbc.
   
   #### shardingsphere-jdbc-example
   - Also as feature examples, `sharding-example` is a direct child of 
`shardingsphere-jdbc-example`, but `encrypt-example` and `shadow-example` are 
placed in the `other-feature-example` directory;
   - `readwrite-splitting` is a feaure too, but the examples are all in the 
`sharding-example` module;
   - Mixed examples should have separate modules, rather than being scattered 
under different example modules;
   
   #### shardingsphere-parser-example
   - Parser is not one of the top products of ShardingSphere and should not be 
placed at the same level as JDBC and Proxy.
   
   
   
   ### Aim
   
   Hope to optimize the structure of examples and adjust it as follows:
   
   ```
   .
   ├── docker
   │   ├── shardingsphere-jdbc [delete]
   │   └── shardingsphere-proxy
   ├── example-core
   ├── shardingsphere-jdbc-example
   │   ├── mixed-feature-example [new]
   │   │   ├── sharding-readwrite-splitting-example [new]
   │   ├── single-feature-example [new]
   │   │   ├── cluster-mode-example
   │   │   ├── encrypt-example
   │   │   ├── extension-example
   │   │   ├── future-shadow-example
   │   │   ├── hint-example(adjust & delete)
   │   │   ├── readwrite-splitting-example (new)
   │   │   ├── shadow-example
   │   │   ├── sharding-example
            (readwrite-splitting example moved to readwrite-splitting-example)
            (sharding & readwrite-splitting example moved to 
mixed-feature-example)
   │   │   ├── transaction-example
   ├── shardingsphere-proxy-example
   ├── other-example [new]
   │   ├── shardingsphere-parser-example
   └── src
   ```
   
   
   
   ### Notice
   Current issue is an overview of the requirement, tasks will be published in 
the related issues. 
   So please **DO NOT** submit any PR to fix this issue, 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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to