Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 贡献文档的修改||feat: Modification of the contribution document #1058

Merged
merged 3 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/good-first-issue-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ API quickstart doc:

API definition(the `.proto` file):

Component development guide: https://mosn.io/layotto/#/en/development/developing-component
Component development guide: https://mosn.io/layotto/en-US/docs/development/developing-component

Component development guide(in chinese): https://mosn.io/layotto/#/zh/development/developing-component
Component development guide(in chinese): https://mosn.io/layotto/docs/development/developing-component

An example pull request to develop a new component:

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/good-first-issue-go-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Develop a golang demo for **(FIXME) XXX** API.

Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API.

You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example:
You can take the [lock api quickstart](https://mosn.io/layotto/en-US/docs/start/lock/start) as an example:

![image](https://user-images.githubusercontent.com/26001097/199906600-d4c92b5e-7b93-4e61-96ca-91c9d96edc04.png)

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/good-first-issue-java-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Develop a java demo for **(FIXME) XXX** API.

Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API.

You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example:
You can take the [lock api quickstart](https://mosn.io/layotto/en-US/docs/start/lock/start) as an example:

![image](https://user-images.githubusercontent.com/26001097/199906799-ac30da05-c983-408b-b0e9-2fd712ec492f.png)

Expand Down
31 changes: 16 additions & 15 deletions .github/workflows/docusaurus-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,20 @@ jobs:
file: 'algolia-config.json'
- name: creates output
run: npm install && npm run build --config docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
external_repository: layotto/layotto.github.io
publish_dir: docs/build
publish_branch: main
# - name: Pushes to another repository
# uses: cpina/github-action-push-to-another-repository@main
# env:
# SSH_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
# - name: Deploy
# uses: peaceiris/actions-gh-pages@v3
# with:
# source-directory: 'docs/build'
# destination-github-username: 'layotto'
# destination-repository-name: 'layotto.github.io'
# target-branch: main
# deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
# external_repository: layotto/layotto.github.io
# publish_dir: docs/build
# publish_branch: main
- name: Pushes to another repository
uses: cpina/github-action-push-to-another-repository@main
env:
SSH_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
with:
source-directory: 'docs/build'
target-directory: 'layotto'
destination-github-username: 'layotto'
destination-repository-name: 'layotto.github.io'
target-branch: main
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

</div>

[查看中文版本](https://mosn.io/layotto/#/zh/README)
[查看中文版本](https://mosn.io/layotto/docs/README)

Layotto(/leɪˈɒtəʊ/) is an application runtime developed using Golang, which provides various distributed capabilities for applications, such as state management, configuration management, and event pub/sub capabilities to simplify application development.

Expand All @@ -22,20 +22,20 @@ Layotto is built on the open source data plane [MOSN](https://github.com/mosn/mo

Layotto aims to combine [Multi-Runtime](https://www.infoq.com/articles/multi-runtime-microservice-architecture/) with Service Mesh into one sidecar. No matter which product you are using as the Service Mesh data plane (e.g. MOSN,Envoy or any other product), you can always attach Layotto to it and add Multi-Runtime capabilities without adding new sidecars.

For example, by adding Runtime capabilities to MOSN, a Layotto process can both [serve as the data plane of istio](https://mosn.io/layotto/#/en/start/istio/) and provide various Runtime APIs (such as Configuration API, Pub/Sub API, etc.)
For example, by adding Runtime capabilities to MOSN, a Layotto process can both [serve as the data plane of istio](https://mosn.io/layotto/en-US/docs/start/istio/) and provide various Runtime APIs (such as Configuration API, Pub/Sub API, etc.)

In addition, we were surprised to find that a sidecar can do much more than that. We are trying to make Layotto even the runtime container of FaaS (Function as a service) with the magic power of [WebAssembly](https://en.wikipedia.org/wiki/WebAssembly) .

## Features

- Service Communication
- Service Governance.Such as traffic hijacking and observation, service rate limiting, etc
- [As the data plane of istio](https://mosn.io/layotto/#/en/start/istio/)
- [As the data plane of istio](https://mosn.io/layotto/en-US/docs/start/istio/)
- Configuration management
- State management
- Event publish and subscribe
- Health check, query runtime metadata
- [FaaS model based on WASM and Runtime](https://mosn.io/layotto/#/en/start/faas/start.md)
- [FaaS model based on WASM and Runtime](https://mosn.io/layotto/en-US/docs/start/faas/start.md)

## Project Architecture

Expand All @@ -49,18 +49,18 @@ Layotto provides SDKs in various languages. The sdk interacts with Layotto throu

### Get started with Layotto

You can try the quickstart demos below to get started with Layotto. In addition, you can experience the [online laboratory](https://mosn.io/layotto/#/en/start/lab)
You can try the quickstart demos below to get started with Layotto. In addition, you can experience the [online laboratory](https://mosn.io/layotto/en-US/docs/start/lab)

### API

| API | status | quick start | desc |
| -------------- | :----: | :-------------------------------------------------------------------: | -------------------------------------------------------------- |
| State | ✅ | [demo](https://mosn.io/layotto/#/en/start/state/start) | Write/Query the data of the Key/Value model |
| Pub/Sub | ✅ | [demo](https://mosn.io/layotto/#/en/start/pubsub/start) | Publish/Subscribe message through various Message Queue |
| Service Invoke | ✅ | [demo](https://mosn.io/layotto/#/en/start/rpc/helloworld) | Call Service through MOSN (another istio data plane) |
| Config | ✅ | [demo](https://mosn.io/layotto/#/en/start/configuration/start-apollo) | Write/Query/Subscribe the config through various Config Center |
| Lock | ✅ | [demo](https://mosn.io/layotto/#/en/start/lock/start) | Distributed lock API |
| Sequencer | ✅ | [demo](https://mosn.io/layotto/#/en/start/sequencer/start) | Generate distributed unique and incremental ID |
| State | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/state/start) | Write/Query the data of the Key/Value model |
| Pub/Sub | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/pubsub/start) | Publish/Subscribe message through various Message Queue |
| Service Invoke | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/rpc/helloworld) | Call Service through MOSN (another istio data plane) |
| Config | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/configuration/start-apollo) | Write/Query/Subscribe the config through various Config Center |
| Lock | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/lock/start) | Distributed lock API |
| Sequencer | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/sequencer/start) | Generate distributed unique and incremental ID |
| File | ✅ | TODO | File API implementation |
| Binding | ✅ | TODO | Transparent data transmission API |

Expand All @@ -69,43 +69,43 @@ You can try the quickstart demos below to get started with Layotto. In addition,

| feature | status | quick start | desc |
| ------- | :----: | :----------------------------------------------------: | -------------------------- |
| istio | ✅ | [demo](https://mosn.io/layotto/#/en/start/istio/) | As the data plane of istio |
| istio | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/istio/) | As the data plane of istio |

### Extendability

| feature | status | quick start | desc |
| ---------- | :----: | :--------------------------------------------------------------: | -------------------------- |
| API plugin | ✅ | [demo](https://mosn.io/layotto/#/en/start/api_plugin/helloworld) | You can add your own API ! |
| API plugin | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/api_plugin/helloworld) | You can add your own API ! |

### Actuator

| feature | status | quick start | desc |
| -------------- | :----: | :-------------------------------------------------------: | --------------------------------------------------- |
| Health Check | ✅ | [demo](https://mosn.io/layotto/#/en/start/actuator/start) | Query health state of app and components in Layotto |
| Metadata Query | ✅ | [demo](https://mosn.io/layotto/#/en/start/actuator/start) | Query metadata in Layotto/app |
| Health Check | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/actuator/start) | Query health state of app and components in Layotto |
| Metadata Query | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/actuator/start) | Query metadata in Layotto/app |

### Traffic Control

| feature | status | quick start | desc |
| ------------ | :----: | :-------------------------------------------------------------------: | --------------------------------------------------------------- |
| TCP Copy | ✅ | [demo](https://mosn.io/layotto/#/en/start/network_filter/tcpcopy) | Dump the tcp traffic received by Layotto into local file system |
| Flow Control | ✅ | [demo](https://mosn.io/layotto/#/en/start/stream_filter/flow_control) | limit access to the APIs provided by Layotto |
| TCP Copy | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/network_filter/tcpcopy) | Dump the tcp traffic received by Layotto into local file system |
| Flow Control | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/stream_filter/flow_control) | limit access to the APIs provided by Layotto |

### Write your bussiness logic using WASM

| feature | status | quick start | desc |
| -------------- | :----: | :---------------------------------------------------: | -------------------------------------------------------------------- |
| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/#/en/start/wasm/start) | Compile Code written by TinyGo to \*.wasm and run in Layotto |
| Rust | ✅ | [demo](https://mosn.io/layotto/#/en/start/wasm/start) | Compile Code written by Rust to \*.wasm and run in Layotto |
| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/#/en/start/wasm/start) | Compile Code written by AssemblyScript to \*.wasm and run in Layotto |
| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/wasm/start) | Compile Code written by TinyGo to \*.wasm and run in Layotto |
| Rust | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/wasm/start) | Compile Code written by Rust to \*.wasm and run in Layotto |
| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/wasm/start) | Compile Code written by AssemblyScript to \*.wasm and run in Layotto |

### As a FaaS(Serverless) runtime (Layotto + WebAssembly + k8s)

| feature | status | quick start | desc |
| -------------- | :----: | :---------------------------------------------------: | ------------------------------------------------------------------------------------------ |
| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/#/en/start/faas/start) | Compile Code written by TinyGo to \*.wasm and run in Layotto And Scheduled by k8s. |
| Rust | ✅ | [demo](https://mosn.io/layotto/#/en/start/faas/start) | Compile Code written by Rust to \*.wasm and run in Layotto And Scheduled by k8s. |
| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/#/en/start/faas/start) | Compile Code written by AssemblyScript to \*.wasm and run in Layotto And Scheduled by k8s. |
| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/faas/start) | Compile Code written by TinyGo to \*.wasm and run in Layotto And Scheduled by k8s. |
| Rust | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/faas/start) | Compile Code written by Rust to \*.wasm and run in Layotto And Scheduled by k8s. |
| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/en-US/docs/start/faas/start) | Compile Code written by AssemblyScript to \*.wasm and run in Layotto And Scheduled by k8s. |

## Presentations

Expand Down
8 changes: 4 additions & 4 deletions algolia-config.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"index_name": "layotto",
"start_urls": [
"https://layotto.github.io/docs",
"https://layotto.github.io/blog",
"https://layotto.github.io/en-US/docs",
"https://layotto.github.io/en-US/blog"
"https://mosn.io/layotto/docs",
"https://mosn.io/layotto/blog",
"https://mosn.io/layotto/en-US/docs",
"https://mosn.io/layotto/en-US/blog"
],
"stop_urls": [
"/tests"
Expand Down
7 changes: 3 additions & 4 deletions crowdin.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
project_id: 688617
# token local testing layotto token
api_token: 7305dcca805d8750a5d0983438bdc4bca9adff6bf35eff5a86dfdca9d85a1c273dd55e8b5362fe8d
#api_token_env: CROWDIN_VERDACCIO_API_KEY

preserve_hierarchy: true

files:
- source: /blog/**/*
translation: '/i18n/%locale%/docusaurus-plugin-content-blog/current/**/%original_file_name%'
- source: /docs/**/*
# - source: docs/blog/**/*
# translation: '/i18n/%locale%/docusaurus-plugin-content-blog/current/**/%original_file_name%'
- source: /docs/docs/**/*
translation: '/i18n/%locale%/docusaurus-plugin-content-docs/current/**/%original_file_name%'
2 changes: 1 addition & 1 deletion demo/faas/code/assemblyscript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ The Node.js version should >=16.14.0.
* npm i
* npm run asbuild
* Copy build/function_1.wasm and build/function_2.wasm to your actual directory.
* Test the demo follow https://mosn.io/layotto/#/zh/start/faas/start.
* Test the demo follow https://mosn.io/layotto/docs/start/faas/start.
2 changes: 1 addition & 1 deletion demo/faas/code/rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

* `cargo build --target=wasm32-unknown-unknown --release`
* Copy `target/wasm32-unknown-unknown/release/function_1.wasm` and `target/wasm32-unknown-unknown/release/function_2.wasm` to your actual directory.
* Test the demo follow [https://mosn.io/layotto/#/zh/start/faas/start](https://mosn.io/layotto/#/zh/start/faas/start).
* Test the demo follow [https://mosn.io/layotto/docs/start/faas/start](https://mosn.io/layotto/docs/start/faas/start).
2 changes: 1 addition & 1 deletion docs/blog/code/layotto-rpc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ func (stm *StageManager) runStartStage() {

### 0x01 Dubbo-go-sample client 发起请求

根据 [Dubbo Json Rpc Example](https://mosn.io/layotto/#/zh/start/rpc/dubbo_json_rpc) 例子运行如下命令
根据 [Dubbo Json Rpc Example](https://mosn.io/layotto/docs/start/rpc/dubbo_json_rpc) 例子运行如下命令

```shell
go run demo/rpc/dubbo_json_rpc/dubbo_json_client/client.go -d '{"jsonrpc":"2.0","method":"GetUser","params":["A003"],"id":9527}'
Expand Down
Loading
Loading