apache / shardingsphere-doc Goto Github PK

• Remove Inherit the Apache Parent POM

• Remove Check dependency impact

• Replace Source code artifacts to Source code distributions in Vote Templates

• ShardingSphere community vote: binding -> PPMC member

We should introduce structure of document and add a guide for how to contribute for document.

Publish to a wrong place

we should split current transaction document into concept, principle, features like sharding.

• Add configuration document for raw orchestrationEncryptDataSource
• Add configuration document for yaml configuring method for orchestrationEncryptDataSource
• Add configuration document for SpringBoot configuring method for orchestrationEncryptDataSource
• Add configuration document for SpringNameSpace configuring method for orchestrationEncryptDataSource
• Update proxy encrypt configuration document
• Add orchestration.xsd

This is a link to the document contribution Guide
https://shardingsphere.apache.org/community/cn/contribute/document-contributor/

Hello there,
I am following the guide to get involved. There is an option to 'Find a mentor from the Developer List', but I can't find developers on the page. The link is in the section of 'Choose Issue' on the page below:
https://shardingsphere.apache.org/community/en/contribute/contributor/

I find the correct link to the developer list on the CONTRIBUTING.md file below:
https://github.com/apache/shardingsphere/blob/master/CONTRIBUTING.md

which indicates the correct link should be:
https://shardingsphere.apache.org/community/en/team/

If it is the solution, I would be happy to fix it in the file.

Thanks,
Hongwei

Add Sharding databases and tables together's configuration on page:
https://shardingsphere.apache.org/document/current/en/manual/sharding-proxy/configuration/

We have release note in https://github.com/apache/incubator-shardingsphere/blob/dev/RELEASE-NOTES.md
But we don't add update release notes into our release procedure, please add it.

Project source address：https://github.com/apache/incubator-shardingsphere-benchmark

• transaction concept & principle
• sharding-jdbc transaction usage.
• swarding-proxy transaction usage
• add seata-at transaction document.

sharding by month
actual-data-nodes=？
eg: t_order_201912

3.1.0好像没有autoCommit这个配置字段了，如果配置文件中有该字段，启动程序会报错。辛苦了解下。

Issue:
I felt difficulty in understanding what project is about and how to contribute if want.

Suggestion:
Please consider including README and Contributing.md if possible.

The last example of "Data Node Configuration" :
db->${0..1}.t_order_0$->{0..9}, db$->{0..1}.t_order_$->{10..20}
Need to be modified to：
db$->{0..1}.t_order_0$->{0..9}, db$->{0..1}.t_order_$->{10..20}

We are support Nacos as reg center now.
FIY: apache/shardingsphere#3150
We need a document for this

update menu style

分库是根据不同区域，如华北、华东....，每个库里面有不通的表（如A库（item_bj,item_tj）,B库（item_sh））。但是我创建TableRule 时候 必须每个库必须有所有城市的分表才可以，否则聚合查询报错。
有没有解决办法呢？多谢

• sctl-sharding-proxy-control-language-cn
• sctl-sharding-proxy-control-language-en

Hi， 请教哈 sharding-sphere 的 docs 文档网站中的图是用什么工具画的呢？比如下面这种 :-D @tristaZero 娟爷

We use Hugo to generate the document website.
The menu of current website cannot collapse, all of sub-menus are displayed which is bad reading experience.

Is there anybody want to investigate about hugo to generate collapsible menu?
FYI: https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu

@terrymanu What kind of drawing tool that your team prefer? Looks cool! Just an example like this pic:

After read documnet in
https://shardingsphere.apache.org/document/legacy/3.x/document/cn/features/sharding/principle/route/
some terms need explanation.
For example:广播路由,全库路由，全库表路由，全实例路由，单播路由，阻断路由。
What is difference among them?

The content of '4.1.2 Configuration manual' should be moved to '4.1 Sharding-JDBC'. As it is very useful for understanding the whole structure of 'sharding-jdbc'.

Add document for Sharding-UI.

• Sharding-UI introduction
• Sharding-UI manual
  • Sharding-UI build manual
  • Registry Center user manual

4.0.0-RC2 version change the configuration for MasterSlaveLoadBalanceAlgorithm.
So we need to update the configuration document and mark the two configuration in 4.0.X document.

The content of poweredby page is a little monotonous. Add more content to it.

FYI: apache/shardingsphere#2853

Sharding-jdbc-spring-boot-starter support to configure JNDI datasource.
Update the usage and configuration example for this.

• usage
• configuration example

the website & doc page's style so dark & distinctive?

please analysis apache projects-list:
http://www.apache.org/index.html#projects-list

Please keep the same level with industry.

1. The static BLACK background color makes people fell depressed.
2. Consistent with the traditional style. Learning from Others apache project website.

Create security page for establish communication channel.

We can reference http://servicecomb.apache.org/security/ and put the page into https://shardingsphere.apache.org/community

In page 'https://shardingsphere.apache.org/document/current/cn/manual/sharding-jdbc/usage/hint/', there is a hint-example link.
After click on it, open a new page with link 'https://github.com/sharding-sphere-example/tree/dev/sharding-jdbc-example/hint-example'.
But, it shows 'Page not found'.

ShardingSphere can process 4 types of SQL (assume id is auto_imcrement):

• INSERT (id, name) VALUES (1, "xxx") =>
  not change
• INSERT (name) VALUES ("xxx") =>
  INSERT (name, id) VALUES ("xxx", ?)
• INSERT VALUES (1, "xxx") =>
  INSERT (id, name) VALUES (1, "xxx")
• INSERT VALUES ("xxx") =>
  INSERT (name, id) VALUES ("xxx", ?)

This feature need to documentation more details.

And we need to add more document for INSERT SET and INSERT for multiple VALUES

FYI: apache/shardingsphere#2846

A script is needed to automatically generate pdf files. @CaymanHK

Spring xsd file in website still use http://shardingsphere.io domain, which may cause some users startup failed with sharding-spring-namespace.

For example:
http://shardingsphere.apache.org/schema/shardingsphere/sharding/sharding.xsd

<xsd:schema xmlns="http://shardingsphere.io/schema/shardingsphere/sharding" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans" targetNamespace="http://shardingsphere.io/schema/shardingsphere/sharding" elementFormDefault="qualified">
<xsd:import namespace="http://www.springframework.org/schema/beans" schemaLocation="http://www.springframework.org/schema/beans/spring-beans.xsd"/>
<xsd:element name="data-source">
....

is there anyway to export the shareding sphere doc as pdf or other format ?

The forced routing page example link does not exist.

v3.1.0 has no autoCommit field, if we config this field in yaml as we did in v3.0.0, sharding-proxy will report an error. Hope for fixing.

我想动态的切换数据源 来实现动态的分表而不是配置文件固定的分表规则，有没有什么好的办法，谢谢

Due to sharding-transaction-spring refactor shardingsphere-spi-impl#35, the document about sharding-transaction should update some dependency.

• update pom dependency for sharding-transaction-spring
• update pom dependency for sharding-transaction-spring-boot-starter