This is an automated email from the ASF dual-hosted git repository.
sunnianjun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shardingsphere-on-cloud.git
The following commit(s) were added to refs/heads/main by this push:
new 8899dd3 docs: update readme and contributing (#152)
8899dd3 is described below
commit 8899dd331afe85a00bc8313b695dc62f95c8084b
Author: liyao <[email protected]>
AuthorDate: Tue Dec 20 18:42:09 2022 +0800
docs: update readme and contributing (#152)
* fix: update doc links
Signed-off-by: mlycore <[email protected]>
* chore: update go version
Signed-off-by: mlycore <[email protected]>
* doc: update contributing
Signed-off-by: mlycore <[email protected]>
* doc: update readme
Signed-off-by: mlycore <[email protected]>
Signed-off-by: mlycore <[email protected]>
---
CONTRIBUTING.md | 26 ++++++--------------------
README.md | 4 ++++
shardingsphere-operator/go.mod | 2 +-
3 files changed, 11 insertions(+), 21 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 64242ed..2ecf089 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,20 +1,6 @@
-# Contributing to ShardingSphere Operator
+# Contributing to ShardingSphere on Cloud
-Thanks for your interest in contributing to ShardingSphere Operator! This
document outlines some of the conventions on building, running, and testing
ShardingSphere Operator, the development workflow, commit message formatting,
contact points and other resources.
-
-
-
-# First ShardingSphere Operator Pull Request
-
-## Prerequisites
-
-To build ShardingSphere Operator from scratch you will need to install the
following tools:
-
-* [Git](https://git-scm.com/)
-* [Golang 1.17](https://golang.org/dl/)
-* [make](https://www.gnu.org/savannah-checkouts/gnu/make/make.html)
-* [Kubernetes 1.20+](https://github.com/kubernetes/kubernetes)
-* [Kubebuilder 3.4.1+](https://github.com/kubernetes-sigs/kubebuilder)
+Thanks for your interest in contributing to ShardingSphere on Cloud!
## Pull Requests
@@ -24,13 +10,13 @@ To build ShardingSphere Operator from scratch you will need
to install the follo
# git clone https://github.com/<yourname>/shardingsphere-on-cloud.git
# cd shardingsphere-on-cloud
- # git remote add upstream
https://github.com/SphereEx/shardingsphere-on-cloud.git
+ # git remote add upstream
https://github.com/apache/shardingsphere-on-cloud.git
# git remote -v
origin https://github.com/<your name>/shardingsphere-on-cloud.git
(fetch)
origin https://github.com/<your name>/shardingsphere-on-cloud.git
(push)
- upstream https://github.com/database-mesh/shardingsphere-on-cloud.git
(fetch)
- upstream https://github.com/database-mesh/shardingsphere-on-cloud.git
(push)
+ upstream https://github.com/apache/shardingsphere-on-cloud.git (fetch)
+ upstream https://github.com/apache/shardingsphere-on-cloud.git (push)
```
2. Open a regular issue for binding the pull request.
3. Submit a Draft Pull Requests, tag your work in progress.
@@ -112,7 +98,7 @@ More types:
* `chore`: updating grunt tasks etc; no production code change.
## Issues
-ShardingSphere Operator uses [GitHub
issues](https://github.com/SphereEx/shardingsphere-on-cloud/issues) to track
bugs. Please include necessary information and instructions to reproduce your
issue.
+ShardingSphere Operator uses [GitHub
issues](https://github.com/apache/shardingsphere-on-cloud/issues) to track
bugs. Please include necessary information and instructions to reproduce your
issue.
## Code of Conduct
Please refer to the [CNCF Code of
Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md),
which describes the expectations for interactions within the community.
diff --git a/README.md b/README.md
index 8e21667..b1f89ff 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,8 @@
This repository collects scripts, tools, manifests and documentations, and
provides a home for [Apache ShardingSphere](https://shardingsphere.apache.org/)
on cloud solutions.
+## Current Status
+
The solutions currently included in this project are:
* [The ShardingSphere Helm
Charts](https://github.com/apache/shardingsphere-on-cloud/tree/main/charts/apache-shardingsphere-proxy-charts)
@@ -25,6 +27,8 @@ To contribute to this project, refer to
[Contributing](CONTRIBUTING.md).
<hr>
+:link: [ShardingSphere on Cloud
Docs](https://shardingsphere.apache.org/oncloud/current/en/overview/). Best
for: Manuals and best practices.
+
:link: [Mailing
List](https://shardingsphere.apache.org/community/en/contribute/subscribe/).
Best for: Apache community updates, releases, changes.
:link: [GitHub
Issues](https://github.com/apache/shardingsphere-on-cloud/issues). Best for:
larger systemic questions/bug reports or anything development related.
diff --git a/shardingsphere-operator/go.mod b/shardingsphere-operator/go.mod
index 72c941c..050d842 100644
--- a/shardingsphere-operator/go.mod
+++ b/shardingsphere-operator/go.mod
@@ -1,6 +1,6 @@
module github.com/apache/shardingsphere-on-cloud/shardingsphere-operator
-go 1.18
+go 1.19
require (
github.com/pkg/errors v0.9.1
