Skip to content

Commit

Permalink
3.0 documentation (apache#1086)
Browse files Browse the repository at this point in the history
  • Loading branch information
chickenlj authored May 20, 2022
1 parent 9b5f1e8 commit 5355c21
Show file tree
Hide file tree
Showing 289 changed files with 14,774 additions and 69 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/build_and_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ on:
push:
branches:
- master
pull_request:
types: [ opened, synchronize, reopened, closed ]
branches:
- master


jobs:
build_and_deploy_job:
Expand Down
4 changes: 4 additions & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ assets/scss/_styles_project.scss
}
}
}

.card-bottom {
margin-bottom: 20px;
}
16 changes: 16 additions & 0 deletions assets/scss/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,20 @@ footer {
}
}

.o-lang-home__list {
& h4 {
margin-bottom: 0.75rem;
}

& ul {
padding-left: 0.25rem;
padding-bottom: 0.5rem;
list-style: none;
}

& li {
padding-bottom: 0.25rem;
}
}

@import "styles_project";
30 changes: 30 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,35 @@ url_latest_version = "https://dubbo.apache.org/zh/docs/"
version = "v2.x"
url = "https://dubbo.apache.org/zh/docsv2.7/"

[[params.versions]]
version = "v3.0(building)"
url = "https://dubbo.apache.org/zh/docs3-building/"


# Add Ecosystems
# en_ecosystem_docs_menu = "Advanced Docs"
# cn_ecosystem_docs_menu = "高级文档"
#
# [[params.ecosystems.docs]]
# ecosystem = "Dubbo Java SDK"
# en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/java-sdk/"
# cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/java-sdk/"
#
# [[params.ecosystems.docs]]
# ecosystem = "Dubbo Golang SDK"
# en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/golang-sdk/"
# cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/golang-sdk/"
#
# [[params.ecosystems.docs]]
# ecosystem = "Dubbo Pixiu"
# en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/pixiu/"
# cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/pixiu/"
#
# [[params.ecosystems.docs]]
# ecosystem = "Dubbo Admin"
# en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/admin/"
# cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/admin/"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/apache/dubbo-website"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
Expand All @@ -128,6 +157,7 @@ sidebar_search_disable = true
navbar_logo = true
# Set to true to disable the About link in the site footer
footer_about_disable = true
navbar_translucent_over_cover_disable = true

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v2.7/user/configuration/xml.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Configure Dubbo with XML"
---


> About the XML configuration items, see:[XML References](../references/xml). If you prefer use API directly instead of using Spring, see [API Configuration](../api). Want an example of how to use configuration, see [Quick Start](../../quick-start).
> About the XML configuration items, see:[XML References](content/old/en/docs/v2.7/user/references/xml). If you prefer use API directly instead of using Spring, see [API Configuration](../api). Want an example of how to use configuration, see [Quick Start](../../quick-start).

## provider.xml demo
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v2.7/user/examples/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 19
description: "Dubbo context"
---

All environment information of during the current call will put into the context,and all configuration information will convert the parameters of `URL` instance,Ref to the column of **URL parameters** at the [schema configuration reference book](../references/xml)
All environment information of during the current call will put into the context,and all configuration information will convert the parameters of `URL` instance,Ref to the column of **URL parameters** at the [schema configuration reference book](content/old/en/docs/v2.7/user/references/xml)


`RpcContext` is a temporary status recorder of `ThreadLocal`,when accept `RPC` request or send `RPC` request,The `RpcContext` will be changed.Such as: `A` call `B` and `B` call `C`. On `B` machine,before `B` call `C`,the `RpcContext` will record the information of `A` call `B`.After `B` call `C`,the `RpcContext` record the information of `B` call `C`.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v2.7/user/recommend.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ The Dubbo default value is used if completely not set up , please see the instru
<dubbo:reference interface="com.alibaba.xxx.XxxService" check="false" />
```

[^1]: Overlay rules for configuration: 1) The method level configuration has a higher priority than the interface level, that is to say,small scope have a high priority 2) Consumer side configuration has a higher priority than provider side, better than global configuration, the last one is the Dubbo hard coded configuration value([Dubbo configuration introduction](./configuration/properties.md))
[^1]: Overlay rules for configuration: 1) The method level configuration has a higher priority than the interface level, that is to say,small scope have a high priority 2) Consumer side configuration has a higher priority than provider side, better than global configuration, the last one is the Dubbo hard coded configuration value([Dubbo configuration introduction](content/old/en/docs/v2.7/user/configuration/properties.md))
[^2]: With the first call, the call will be called 3 times
[^3]: How to select a service to call when there are multiple Provider services
[^4]: It means that consumer service can call the best provider service, and reduce to call the the slow provider service.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v2.7/user/references/registry/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ A home-brewed service registry server is used in Alibaba instead of redis server
## Installation


Pls. refer to [redis install manual](http://dubbo.apache.org/en-us/docs/admin/install/redis.html) for how to install a redis based registry server. To set it up, specify `dubbo.registry.address` to `redis://127.0.0.1:6379` in `conf/dubbo.properties` for both provider and consumer (you can refer to [quick start](../../quick-start.md)) after install a redis server.
Pls. refer to [redis install manual](http://dubbo.apache.org/en-us/docs/admin/install/redis.html) for how to install a redis based registry server. To set it up, specify `dubbo.registry.address` to `redis://127.0.0.1:6379` in `conf/dubbo.properties` for both provider and consumer (you can refer to [quick start](content/old/en/docs/v2.7/user/quick-start.md)) after install a redis server.


[^1]: [Redis](http://redis.io) is a high performance KV cache server
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v2.7/user/references/registry/zookeeper.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Configure single zookeeper to serve as multiple registry servers:
## Zookeeper Installation


Pls. refer to [zookeeper install manual](../../../admin/install/zookeeper.md) for how to install zookeeper based registry server. To set it up, specify `dubbo.registry.address` to `zookeeper://127.0.0.1:2181` in `conf/dubbo.properties` for both provider and consumer (you can refer to [quick start](../../quick-start.md)) after install a zookeeper server.
Pls. refer to [zookeeper install manual](content/old/en/docs/v2.7/admin/install/zookeeper.md) for how to install zookeeper based registry server. To set it up, specify `dubbo.registry.address` to `zookeeper://127.0.0.1:2181` in `conf/dubbo.properties` for both provider and consumer (you can refer to [quick start](content/old/en/docs/v2.7/user/quick-start.md)) after install a zookeeper server.


## Declaration of Reliability
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/v3.0/languages/erlang/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ into the project's `apps` directory.
```

## Consumer configuration
Please reference [Reference Config](./reference.md)
Please reference [Reference Config](content/old/en/docs/v3.0/languages/erlang/reference.md)

## Init dubbolib in your project
It is need you
Expand Down
8 changes: 8 additions & 0 deletions content/en/latest/admin/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

---
type: advanced-docs
title: "admin"
linkTitle: "admin"
weight: 3
---

186 changes: 186 additions & 0 deletions content/en/latest/community/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
---
title: Community
menu:
main:
weight: 40
---

<!--add blocks of content here to add more sections to the community page -->
{{% blocks/lead %}}
You may consider contributing more to the following side projects of Apache Dubbo:
{{% /blocks/lead %}}

{{< blocks/section color="white" height="auto">}}
<div class="row container-fluid pb-5">
<div class="col-3">
<div class="card" >
<div class="card-body" >
<h5 class="card-title">dubbo-go</h5>
<h6 class="card-subtitle mb-2 text-muted">languages</h6>
<p class="card-text">golang implementation</p>
<a href="https://github.com/apache/dubbo-go" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-js</h5>
<h6 class="card-subtitle mb-2 text-muted">language</h6>
<p class="card-text">js implementation</p>
<a href="https://github.com/apache/dubbo-js" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-php</h5>
<h6 class="card-subtitle mb-2 text-muted">languages</h6>
<p class="card-text">php implementation</p>
<a href="https://github.com/apache/dubbo-php-framework" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-python</h5>
<h6 class="card-subtitle mb-2 text-muted">languages</h6>
<p class="card-text">python implementation</p>
<a href="https://github.com/apache/dubbo-python" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
</div>

<div class="row container-fluid pb-5">
<div class="col-3">
<div class="card" >
<div class="card-body" >
<h5 class="card-title">dubbo-erlang</h5>
<h6 class="card-subtitle mb-2 text-muted">languages</h6>
<p class="card-text">erlang implementation</p>
<a href="https://github.com/apache/dubbo-erlang" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-website</h5>
<h6 class="card-subtitle mb-2 text-muted">documentation</h6>
<p class="card-text">Dubbo Official Website</p>
<a href="https://github.com/apache/dubbo-website" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-samples</h5>
<h6 class="card-subtitle mb-2 text-muted">samples</h6>
<p class="card-text">Dubbo java samples</p>
<a href="https://github.com/apache/dubbo-samples" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-go-samples</h5>
<h6 class="card-subtitle mb-2 text-muted">samples</h6>
<p class="card-text">Dubbo golang samples</p>
<a href="https://github.com/apache/dubbo-go-samples" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
</div>

<div class="row container-fluid pb-5">
<div class="col-3">
<div class="card" >
<div class="card-body" >
<h5 class="card-title">dubbo-admin</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Dubbo admin console</p>
<a href="https://github.com/apache/dubbo-admin" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-spring-boot</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Spring Boot Starter</p>
<a href="https://github.com/apache/dubbo-spring-boot-project" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-go-hessian2</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Hessian2 golang library</p>
<a href="https://github.com/apache/dubbo-go-hessian2" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-proxy</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Dubbo proxy server</p>
<a href="https://github.com/apache/dubbo-proxy" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
</div>

<div class="row container-fluid pb-5">
<div class="col-3">
<div class="card" >
<div class="card-body" >
<h5 class="card-title">dubbo-hessian-lite</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Hessian java library</p>
<a href="https://github.com/apache/dubbo-hessian-lite" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-getty</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Dubbo-go networking library</p>
<a href="https://github.com/apache/dubbo-getty" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-spi-extensions</h5>
<h6 class="card-subtitle mb-2 text-muted">SPI extensions</h6>
<p class="card-text">Dubbo extension collections</p>
<a href="https://github.com/apache/dubbo-spi-extensions" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
<div class="col-3">
<div class="card">
<div class="card-body" >
<h5 class="card-title">dubbo-awesome</h5>
<h6 class="card-subtitle mb-2 text-muted">eco-system</h6>
<p class="card-text">Dubbo resource collections</p>
<a href="https://github.com/apache/dubbo-awesome" class="card-link text-primary">GitHub > </a>
</div>
</div>
</div>
</div>
{{< /blocks/section >}}

Loading

0 comments on commit 5355c21

Please sign in to comment.