You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ti...@apache.org on 2020/07/13 12:21:44 UTC
[servicecomb-service-center] branch master updated: update links of
docs (#664)
This is an automated email from the ASF dual-hosted git repository.
tianxiaoliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-service-center.git
The following commit(s) were added to refs/heads/master by this push:
new 2c3cb78 update links of docs (#664)
2c3cb78 is described below
commit 2c3cb78800a2789d267103be6b1dcd15b5292db0
Author: hityc2019 <48...@users.noreply.github.com>
AuthorDate: Mon Jul 13 20:21:37 2020 +0800
update links of docs (#664)
---
README.md | 16 ++++++++--------
docs/README.md | 30 ++++++++++++++++++++++++++++++
docs/design-guides/plugin.md | 2 +-
docs/dev-guides/extendmodule.md | 2 +-
docs/dev-guides/kubeclusters.rst | 2 +-
docs/dev-guides/multidcs.rst | 6 +++---
docs/dev-guides/multidcs2.rst | 4 ++--
7 files changed, 46 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 8071cf1..c90160b 100644
--- a/README.md
+++ b/README.md
@@ -23,18 +23,18 @@ It provides out of box support for metrics and tracing. It has a web portal to m
- **[`Portal`](/frontend)**: Awesome web portal
- **Fault tolerance**: Multiple fault tolerance mechanism and design in the architecture
- **Performance**: Performance/Caching design
- - **[`Metrics`](/docs/integration-grafana.md)**: Able to expose Prometheus metric API automatically
- - **[`Tracing`](/docs/tracing.md)**: Able to report tracing data to Zipkin server
- - **[`Pluginable`](/docs/plugin.md)**: Able to load custom authentication, tls and other dynamic libraries
- - **[`CLI`](/scctl/README.md)**: Easy to control service center
- - **[`Kubernetes`](/docs/kubeclusters.md)**: Embrace kubernetes ecosystem and support multi cluster service discovery
- - **[`Datacenters`](/docs/multidcs.md)**: Additional layer of abstraction to clusters deployed in multiple datacenters
- - **[`Aggregation`](/docs/aggregate.md)**: Able to aggregate microservices from multiple registry platforms and
+ - **[`Metrics`](/docs/user-guides/integration-grafana.md)**: Able to expose Prometheus metric API automatically
+ - **[`Tracing`](/docs/plugins-tracing/tracing.md)**: Able to report tracing data to Zipkin server
+ - **[`Pluginable`](/docs/design-guides/plugin.md)**: Able to load custom authentication, tls and other dynamic libraries
+ - **[`CLI`](/docs/intro/scctl.md)**: Easy to control service center
+ - **[`Kubernetes`](/docs/dev-guides/kubeclusters.rst)**: Embrace kubernetes ecosystem and support multi cluster service discovery
+ - **[`Datacenters`](/docs/dev-guides/multidcs.rst)**: Additional layer of abstraction to clusters deployed in multiple datacenters
+ - **[`Aggregation`](/docs/design-guides/aggregator-design.PNG)**: Able to aggregate microservices from multiple registry platforms and
support platform registry and client side registry at the same time
## Documentation
-Project documentation is available on the [ServiceComb website][servicecomb-website]. You can also find full document [`here`](/docs/README.md).
+Project documentation is available on the [ServiceComb website][servicecomb-website]. You can also find full document [`here`](/docs).
[servicecomb-website]: http://servicecomb.apache.org/
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..bffe96a
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,30 @@
+# How to write doc in local
+
+## Prepare
+1. Install Python 3.X
+1. Install pip3
+1. Install sphinx(>=2.0.0) support https://docs.readthedocs.io/en/latest/getting_started.html
+1. Install RTD module & recommonmark
+```shell
+sudo pip install sphinx_rtd_theme
+sudo pip install recommonmark
+```
+
+## Generate doc
+
+In windows
+```shell
+cd docs
+make.bat html
+```
+
+In linux
+```shell
+cd docs
+make html
+```
+
+## Check the result
+
+1. See html pages in _build folder
+2. You can start a http server using `python -m http.server` which will serve at http://0.0.0.0:8000/.
diff --git a/docs/design-guides/plugin.md b/docs/design-guides/plugin.md
index cea6ddb..e2b3bcb 100644
--- a/docs/design-guides/plugin.md
+++ b/docs/design-guides/plugin.md
@@ -18,7 +18,7 @@
### Step 1: code auth.go
-auth.go is the implement from [auth interface](https://github.com/apache/servicecomb-service-center/blob/master/server/plugin/pkg/auth/auth.go)
+auth.go is the implement from [auth interface](https://github.com/apache/servicecomb-service-center/blob/master/server/plugin/auth/auth.go)
```go
package main
diff --git a/docs/dev-guides/extendmodule.md b/docs/dev-guides/extendmodule.md
index 7247fef..f48d7cb 100644
--- a/docs/dev-guides/extendmodule.md
+++ b/docs/dev-guides/extendmodule.md
@@ -59,4 +59,4 @@ import _ "github.com/apache/servicecomb-service-center/server/hello"
## About GRPC module
-To see [govern](https://github.com/apache/servicecomb-service-center/tree/master/server/govern) module for help.
\ No newline at end of file
+To see [govern](https://github.com/apache/servicecomb-service-center/tree/master/server/rest/govern) module for help.
\ No newline at end of file
diff --git a/docs/dev-guides/kubeclusters.rst b/docs/dev-guides/kubeclusters.rst
index 5852070..9526d86 100644
--- a/docs/dev-guides/kubeclusters.rst
+++ b/docs/dev-guides/kubeclusters.rst
@@ -131,5 +131,5 @@ Since client is not a service, we check its running log.
2018/09/29 10:30:25 AddEmploy ------------------------------ employList:<name:"One" phone:"15989351111" >
-.. _Multiple Datacenters: multidcs.rst
+.. _Multiple Datacenters: https://service-center.readthedocs.io/en/latest/dev-guides/multidcs.html
.. _here: https://github.com/apache/servicecomb-service-center/tree/master/scctl/examples/infrastructures/k8s
\ No newline at end of file
diff --git a/docs/dev-guides/multidcs.rst b/docs/dev-guides/multidcs.rst
index 6816d7c..58c9ce7 100644
--- a/docs/dev-guides/multidcs.rst
+++ b/docs/dev-guides/multidcs.rst
@@ -144,11 +144,11 @@ Since client is not a service, we check its running log.
2018/09/29 10:30:25 AddEmploy ------------------------------ employList:<name:"One" phone:"15989351111" >
-.. _this: ../user-guides/sc-cluster.rst
-.. _scctl: ../intro/scctl.md
+.. _this: https://service-center.readthedocs.io/en/latest/user-guides/sc-cluster.html
+.. _scctl: https://service-center.readthedocs.io/en/latest/intro/scctl.html#scctl
.. _cluster command: https://github.com/apache/servicecomb-service-center/blob/master/scctl/pkg/plugin/README.md#cluster-options
.. _example: https://github.com/go-chassis/go-chassis/tree/master/examples/discovery
.. _go-chassis: https://github.com/go-chassis/go-chassis
.. _java-chassis: https://github.com/apache/servicecomb-java-chassis
-.. _here: multidcs2.rst
+.. _here: https://service-center.readthedocs.io/en/latest/dev-guides/multidcs2.html
diff --git a/docs/dev-guides/multidcs2.rst b/docs/dev-guides/multidcs2.rst
index 7b2d538..fe4a914 100644
--- a/docs/dev-guides/multidcs2.rst
+++ b/docs/dev-guides/multidcs2.rst
@@ -140,9 +140,9 @@ Since ``springmvc-client`` is not a service, we check its running log.
[2018-10-19 23:04:42,800/CST][main][INFO]............. test finished ............ org.apache.servicecomb.demo.TestMgr.summary(TestMgr.java:83)
-.. _multiple data center: multidcs.rst
+.. _multiple data center: https://service-center.readthedocs.io/en/latest/dev-guides/multidcs.html
.. _java-chassis: https://github.com/apache/servicecomb-java-chassis
.. _this: https://github.com/coreos/etcd/blob/master/Documentation/op-guide/container.md
-.. _scctl: ../scctl/README.md
+.. _scctl: https://service-center.readthedocs.io/en/latest/intro/scctl.html#scctl
.. _cluster command: https://github.com/apache/servicecomb-service-center/tree/master/scctl/pkg/plugin/README.md#cluster-options
.. _example: https://github.com/apache/servicecomb-java-chassis/tree/master/demo/demo-springmvc
\ No newline at end of file