hf200012 opened a new pull request #8757:
URL: https://github.com/apache/incubator-doris/pull/8757


   I started a discussion on this before, you can check it in the mail group
   
   https://lists.apache.org/thread/o770bc3k623kyfks2mzkt21qsc4g6328
   
   In order to facilitate everyone to organize the documents, I created a 
new-docs directory under the incubator-doris directory. The new directory 
structure is below this. I just created a directory structure here, which needs 
to be rearranged.
   
   In the data import scenario, in order to take into account the viewing 
habits of previous users, the import is organized in two ways:
   
   1. According to the usage scenario: This will give users clearer guidance. 
For example, the user is the data source of kafka, then the user can directly 
select the routine to load
   2. According to the import method: it is the introduction of the various 
import methods we provided before
   
   In order to facilitate everyone to run and debug locally, I migrated the 
entire .vuepress under the original document. After completion, you only need 
to delete the original docs directory and rename the new new-docs directory to 
docs. At the same time, you can also run it locally, so that you can organize 
documents and know the content of each document directory.
   
   In the local debugging execution, switch to the new-docs directory and 
execute the following command:
   
   ````
   npm install
   npm run dev
   ````
   then through the browser
   http://ip:port/zh-CN
   http://ip:port/en
   
   The specific directory structure is as follows (the Chinese directory is 
used as an example to show below):
   ```
   .
   ├── README.md
   ├── admin-manual
   │   ├── cluster-admin
   │   │   └── doris-ha.md
   │   ├── config
   │   │   ├── be-config.md
   │   │   ├── fe-config.md
   │   │   └── user-property.md
   │   ├── data-admin
   │   │   ├── backup.md
   │   │   ├── delete-recover.md
   │   │   └── restore.md
   │   ├── elastic-expansion.md
   │   ├── ldap.md
   │   ├── maint-monitor
   │   │   ├── be-olap-error-code.md
   │   │   ├── disk-capacity.md
   │   │   ├── doris-error-code.md
   │   │   ├── metadata-operation.md
   │   │   ├── monitor-alert.md
   │   │   ├── monitor-metrics
   │   │   ├── tablet-meta-tool.md
   │   │   ├── tablet-repair-and-balance.md
   │   │   └── tablet-restore-tool.md
   │   ├── multi-tenant.md
   │   ├── optimization.md
   │   ├── query-profile.md
   │   ├── upgrade.md
   │   └── user-privilege.md
   ├── advanced
   │   ├── bucket-shuffle-join.md
   │   ├── cache
   │   │   ├── partition-cache.md
   │   │   └── query-cache.md
   │   ├── colocation-join.md
   │   ├── materialized-view.md
   │   ├── orthogonal-bitmap-manual.md
   │   ├── orthogonal-hll-manual.md
   │   ├── partition
   │   │   ├── dynamic-partition.md
   │   │   └── table-tmp-partition.md
   │   ├── runtime-filter.md
   │   ├── schema-change.md
   │   ├── small-file-mgr.md
   │   ├── time-zone.md
   │   └── variables.md
   ├── benchmark
   │   ├── ssb.md
   │   └── tpc-h.md
   ├── data-operate
   │   ├── export
   │   │   ├── export-manual.md
   │   │   ├── export_with_mysql_dump.md
   │   │   └── outfile.md
   │   ├── import
   │   │   ├── import-scenes
   │   │   ├── import-way
   │   │   └── load-manual.md
   │   └── update-delete
   │       ├── batch-delete-manual.md
   │       ├── delete-manual.md
   │       ├── sequence-column-manual.md
   │       └── update.md
   ├── data-table
   │   ├── advance-usage.md
   │   ├── basic-usage.md
   │   ├── best-practice.md
   │   ├── data-model.md
   │   ├── data-partition.md
   │   ├── hit-the-rollup.md
   │   └── index
   │       ├── bitmap-index.md
   │       ├── bloomfilter.md
   │       └── prefix-index.md
   ├── doris-manager
   ├── ecosystem
   │   ├── audit-plugin.md
   │   ├── datax.md
   │   ├── external-table
   │   │   ├── doris-on-es.md
   │   │   ├── hive-bitmap-udf.md
   │   │   ├── hive-of-doris.md
   │   │   ├── iceberg-of-doris.md
   │   │   └── odbc-of-doris.md
   │   ├── flink-doris-connector.md
   │   ├── logstash.md
   │   ├── plugin-development-manual.md
   │   ├── seatunnel
   │   │   ├── flink-sink.md
   │   │   └── spark-sink.md
   │   ├── spark-doris-connector.md
   │   └── udf
   │       ├── contribute-udf.md
   │       ├── native-user-defined-function.md
   │       └── remote-user-defined-function.md
   ├── faq
   │   ├── data-faq.md
   │   ├── install-faq.md
   │   └── sql-faq.md
   ├── get-starting
   │   └── get-starting.md
   ├── install
   │   ├── docker-install.md
   │   ├── install-deploy.md
   │   └── source-install
   │       ├── compilation-arm.md
   │       ├── compilation-with-ldb-toolchain.md
   │       └── compilation.md
   ├── sql-manual
   │   ├── sql-functions
   │   │   ├── aggregate-functions
   │   │   ├── bitmap-functions
   │   │   ├── bitwise-functions
   │   │   ├── cast.md
   │   │   ├── conditional-functions
   │   │   ├── date-time-functions
   │   │   ├── digital-masking.md
   │   │   ├── encrypt-digest-functions
   │   │   ├── hash-functions
   │   │   ├── json-functions
   │   │   ├── math-functions
   │   │   ├── spatial-functions
   │   │   ├── string-functions
   │   │   │   ├── like
   │   │   │   └── regexp
   │   │   ├── table-functions
   │   │   └── window-function.md
   │   └── sql-reference-v2
   │       ├── Account-Management-Statements
   │       │   ├── ALTER-USER.md
   │       │   ├── CREATE-ROLE.md
   │       │   ├── CREATE-USER.md
   │       │   ├── DROP-ROLE.md
   │       │   ├── DROP-USER.md
   │       │   ├── GRANT.md
   │       │   ├── LDAP.md
   │       │   ├── REVOKE.md
   │       │   ├── SET-PASSWORD.md
   │       │   └── SET-PROPERTY.md
   │       ├── Cluster-Management-Statements
   │       │   ├── ALTER-SYSTEM-ADD-BACKEND.md
   │       │   ├── ALTER-SYSTEM-ADD-FOLLOWER.md
   │       │   ├── ALTER-SYSTEM-ADD-OBSERVER.md
   │       │   ├── ALTER-SYSTEM-DECOMMISSION-BACKEND.md
   │       │   ├── ALTER-SYSTEM-DROP-BACKEND.md
   │       │   ├── ALTER-SYSTEM-DROP-FOLLOWER.md
   │       │   ├── ALTER-SYSTEM-DROP-OBSERVER.md
   │       │   ├── ALTER-SYSTEM-MODIFY-BROKER.md
   │       │   └── CANCEL-ALTER-SYSTEM.md
   │       ├── Data-Definition-Statements
   │       │   ├── Alter
   │       │   │   ├── ALTER-DATABASE.md
   │       │   │   ├── ALTER-TABLE-COLUMN.md
   │       │   │   ├── ALTER-TABLE-PARTITION.md
   │       │   │   ├── ALTER-TABLE-PROPERTY.md
   │       │   │   ├── ALTER-TABLE-RENAME.md
   │       │   │   ├── ALTER-TABLE-REPLACE.md
   │       │   │   ├── ALTER-TABLE-ROLLUP.md
   │       │   │   ├── ALTER-VIEW.md
   │       │   │   └── CANCEL-ALTER-TABLE.md
   │       │   ├── Backup-and-Restore
   │       │   │   ├── BACKUP.md
   │       │   │   ├── CANCEL-BACKUP.md
   │       │   │   ├── CANCEL-RESTORE.md
   │       │   │   ├── CREATE-REPOSITORY.md
   │       │   │   ├── DROP-REPOSITORY.md
   │       │   │   └── RESTORE.md
   │       │   ├── Create
   │       │   │   ├── CREATE-DATABASE.md
   │       │   │   ├── CREATE-ENCRYPT-KEY.md
   │       │   │   ├── CREATE-FILE.md
   │       │   │   ├── CREATE-FUNCTION.md
   │       │   │   ├── CREATE-INDEX.md
   │       │   │   ├── CREATE-MATERIALIZED-VIEW.md
   │       │   │   ├── CREATE-RESOURCE.md
   │       │   │   ├── CREATE-TABLE-LIKE.md
   │       │   │   ├── CREATE-TABLE.md
   │       │   │   └── CREATE-VIEW.md
   │       │   └── Drop
   │       │       ├── DROP-DATABASE.md
   │       │       ├── DROP-ENCRYPT-KEY.md
   │       │       ├── DROP-FILE.md
   │       │       ├── DROP-FUNCTION.md
   │       │       ├── DROP-INDEX.md
   │       │       ├── DROP-MATERIALIZED-VIEW.md
   │       │       ├── DROP-RESOURCE.md
   │       │       ├── DROP-TABLE.md
   │       │       └── TRUNCATE-TABLE.md
   │       ├── Data-Manipulation-Statements
   │       │   ├── Load
   │       │   │   ├── ALTER-ROUTINE-LOAD.md
   │       │   │   ├── BROKER-LOAD.md
   │       │   │   ├── CANCEL-LOAD.md
   │       │   │   ├── CREATE-ROUTINE-LOAD.md
   │       │   │   ├── PAUSE-ROUTINE-LOAD.md
   │       │   │   ├── RESUME-ROUTINE-LOAD.md
   │       │   │   ├── STOP-ROUTINE-LOAD.md
   │       │   │   └── STREAM-LOAD.md
   │       │   └── Manipulation
   │       │       ├── DELETE.md
   │       │       ├── INSERT.md
   │       │       └── UPDATE.md
   │       ├── Data-Types
   │       │   ├── BIGINT.md
   │       │   ├── BITMAP.md
   │       │   ├── BOOLEAN.md
   │       │   ├── CHAR.md
   │       │   ├── DATE.md
   │       │   ├── DATETIME.md
   │       │   ├── DECIMAL.md
   │       │   ├── DOUBLE.md
   │       │   ├── FLOAT.md
   │       │   ├── HLL.md
   │       │   ├── INT.md
   │       │   ├── LARGEINT.md
   │       │   ├── QUANTILE_STATE.md
   │       │   ├── SMALLINT.md
   │       │   ├── STRING.md
   │       │   ├── TINYINT.md
   │       │   └── VARCHAR.md
   │       ├── Database-Administration-Statements
   │       │   ├── ADMIN-CANCEL-REPAIR.md
   │       │   ├── ADMIN-CHECK-TABLET.md
   │       │   ├── ADMIN-REPAIR-TABLE.md
   │       │   ├── ADMIN-SET-CONFIG.md
   │       │   ├── ADMIN-SET-REPLICA-STATUS.md
   │       │   ├── ADMIN-SHOW-CONFIG.md
   │       │   ├── ADMIN-SHOW-REPLICA-DISTRIBUTION.md
   │       │   ├── ADMIN-SHOW-REPLICA-STATUS.md
   │       │   ├── ENABLE-FEATURE.md
   │       │   ├── INSTALL-PLUGIN.md
   │       │   ├── KILL.md
   │       │   ├── RECOVER.md
   │       │   ├── SET-VARIABLE.md
   │       │   └── UNINSTALL-PLUGIN.md
   │       ├── Show-Statements
   │       │   ├── SHOW-ALTER.md
   │       │   ├── SHOW-BACKENDS.md
   │       │   ├── SHOW-BACKUP.md
   │       │   ├── SHOW-BROKER.md
   │       │   ├── SHOW-CHARSET.md
   │       │   ├── SHOW-COLLATION.md
   │       │   ├── SHOW-COLUMNS.md
   │       │   ├── SHOW-CREATE-DATABASE.md
   │       │   ├── SHOW-CREATE-FUNCTION.md
   │       │   ├── SHOW-CREATE-ROUTINE-LOAD.md
   │       │   ├── SHOW-CREATE-TABLE.md
   │       │   ├── SHOW-DATA.md
   │       │   ├── SHOW-DATABASE-ID.md
   │       │   ├── SHOW-DATABASES.md
   │       │   ├── SHOW-DELETE.md
   │       │   ├── SHOW-DYNAMIC-PARTITION.md
   │       │   ├── SHOW-ENCRYPT-KEY.md
   │       │   ├── SHOW-ENGINES.md
   │       │   ├── SHOW-EVENTS.md
   │       │   ├── SHOW-EXPORT.md
   │       │   ├── SHOW-FRONTENDS.md
   │       │   ├── SHOW-FUNCTIONS.md
   │       │   ├── SHOW-GRANTS.md
   │       │   ├── SHOW-INDEX.md
   │       │   ├── SHOW-LOAD-PROFILE.md
   │       │   ├── SHOW-LOAD-WARNINGS.md
   │       │   ├── SHOW-LOAD.md
   │       │   ├── SHOW-MIGRATIONS.md
   │       │   ├── SHOW-OPEN-TABLES.md
   │       │   ├── SHOW-PARTITION-ID.md
   │       │   ├── SHOW-PARTITIONS.md
   │       │   ├── SHOW-PLUGINS.md
   │       │   ├── SHOW-PROC.md
   │       │   ├── SHOW-PROCEDURE.md
   │       │   ├── SHOW-PROCESSLIST.md
   │       │   ├── SHOW-PROPERTY.md
   │       │   ├── SHOW-QUERY-PROFILE.md
   │       │   ├── SHOW-REPOSITORIES.md
   │       │   ├── SHOW-RESOURCES.md
   │       │   ├── SHOW-RESTORE.md
   │       │   ├── SHOW-ROLES.md
   │       │   ├── SHOW-ROLLUP.md
   │       │   ├── SHOW-ROUTINE-LOAD-TASK.md
   │       │   ├── SHOW-ROUTINE-LOAD.md
   │       │   ├── SHOW-SMALL-FILES.md
   │       │   ├── SHOW-SNAPSHOT.md
   │       │   ├── SHOW-STATUS.md
   │       │   ├── SHOW-STREAM-LOAD.md
   │       │   ├── SHOW-TABLE-ID.md
   │       │   ├── SHOW-TABLE-STATUS.md
   │       │   ├── SHOW-TABLET.md
   │       │   ├── SHOW-TRANSACTION.md
   │       │   ├── SHOW-TRIGGERS.md
   │       │   ├── SHOW-USER.md
   │       │   ├── SHOW-VARIABLES.md
   │       │   ├── SHOW-VIEW.md
   │       │   ├── SHOW-WARNING.md
   │       │   └── SHOW-WHITE-LIST.md
   │       └── Utility-Statements
   │           ├── DESCRIBE.md
   │           ├── HELP.md
   │           └── USE.md
   └── summary
       ├── basic-summary.md
       └── system-architecture.md
   ```
   
   # Proposed changes
   
   Issue Number: close #xxx
   
   ## Problem Summary:
   
   Describe the overview of changes.
   
   ## Checklist(Required)
   
   1. Does it affect the original behavior: (Yes/No/I Don't know)
   2. Has unit tests been added: (Yes/No/No Need)
   3. Has document been added or modified: (Yes/No/No Need)
   4. Does it need to update dependencies: (Yes/No)
   5. Are there any changes that cannot be rolled back: (Yes/No)
   
   ## Further comments
   
   If this is a relatively large or complex change, kick off the discussion at 
[[email protected]](mailto:[email protected]) by explaining why you 
chose the solution you did and what alternatives you considered, etc...
   


-- 
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]



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to