Determine new document structure

[terrymanu]

There are more and more features in ShardingSphere, and there are lots of configurations and usages need to be clear.
I want to discuss the new structure of documents.

The principles of document structure are:

1. Classify documents, make rules for every document type, for example: background, feature, concept, user manual, dev manual etc.
2. Make rules for details pages, for example: user-manual/distsql, user-manual/yaml, user-manual/spring-boot-starter.
3. Abstract rules for document conduct with markdown syntax.

This is my plan:

• Overview
  • What is ShardingSphere
    • Merge Advantages into What is ShardingSphere
  • Design Philosophy
  • JDBC & Proxy
  • DistSQL
  • Mode
• Features: Add appendix with SQL operator for each feature
  • Sharding
  • Introduction: Background, Application Scenario
    • Concept: Table, Data Node, Sharding, Inline Expression, Distributed PK, Hint
    • Limitations
    • Appendix with SQL operator
  • Distributed Transaction
  • Readwrite-splitting
  • HA
  • Database Gateway
    • Concept: Protocol Dialect, Storage Dialect, Translator
    • Application Scenario
    • Limitation
  • Traffic Governance
    • Concept: Circuit Breaker, Request Limitation
    • Application Scenario
    • Limitation
  • Data Migration
  • Encryption
  • Shadow
  • Observability
• Quick Start
  • ShardingSphere-JDBC
  • ShardingSphere-Proxy
• User Manual
  • ShardingSphere-JDBC
    • YAML: YamlShardingSphereDataSourceFactory (Deprecated), JDBC Driver
      • Mode
      • Data Source
      • Rule
      • Algorithm
    • Java API
      • Mode
      • Data Source
      • Rule
      • Algorithm
    • Spring Boot Starter
      • Mode
      • Data Source
      • Rule
      • Algorithm
    • Spring Namespace
      • Mode
      • Data Source
      • Rule
      • Algorithm
    • Special API
    • Unsupported Items
  • ShardingSphere-Proxy
    • DistSQL
      • Syntax
        • RQL
        • RDL
        • RAL
        • RUL
      • Usage
        • Sharding
        • ...
    • YAML
      • Database Config
      • Server Config
        • Rule
        • Properties
    • Scaling (?)
  • Common Configuration
    • Properties
    • Built-in Algorithm
• Dev Manual
• Test Manual
• Implementation

After the structure decided, we need to decide document template for each type.

[github-actions[bot]]

Hello , this issue has not received a reply for several days.
This issue is supposed to be closed.