Skip to content

Commit

Permalink
feat: layotto改造 (#1054)
Browse files Browse the repository at this point in the history
* layotto docs改动和配置文件改动

* layotto docs改动和配置文件改动

* layotto docs改动和配置文件改动

* 格式check改动

* 格式check改动

* 格式check改动

* 格式check改动

* 格式check改动-恢复

* 格式check改动-恢复2

* 格式check改动-恢复3

* 格式check改动-恢复4

* 格式check改动-恢复4

* 格式check改动-恢复5

* 格式check改动-恢复5

* 格式check改动-恢复5

* 格式check改动-恢复5

* 格式check改动-恢复5

* 格式check改动-恢复5

* 格式check改动-恢复5

* 格式check改动-恢复5

* 文档链接调整

* 文档链接调整

* 文档链接调整

* 文档链接调整

* 格式check改动-恢复5

* 文档链接调整

* 格式check改动-恢复5

* 格式check改动-恢复5

* 触发测试1

* 触发测试2

* 触发测试2

* 触发测试3

* 触发测试4

* 触发测试4

* 触发测试4

* 触发测试4

* 修改文件链接

* 修改文件链接

* 修改文件链接

* 修改文件链接

* 死链调整

* 修改文件链接

* 修改文件链接

* 修改文件链接

* Merge remote-tracking branch 'origin/main'

* Merge remote-tracking branch 'origin/main'

* Merge remote-tracking branch 'origin/main'

* Merge remote-tracking branch 'origin/main'

* 死链调整

* Merge remote-tracking branch 'origin/main'

* Merge remote-tracking branch 'origin/main'

* 部署完成,爬虫URL改成正式的url

---------

Co-authored-by: [email protected] <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Duan-0916 <[email protected]>
Co-authored-by: Marco <[email protected]>
  • Loading branch information
5 people authored Jul 5, 2024
1 parent 3bf8bca commit 3d39dd7
Show file tree
Hide file tree
Showing 435 changed files with 24,429 additions and 15,344 deletions.
34 changes: 25 additions & 9 deletions .github/dead_link_check_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,51 @@
"pattern": "^https://docs.buf.build/"
},
{
"pattern":"^https://techhenzy.com/proxy-webassembly-architecture/"
"pattern":"^https://techhenzy.com/"
},
{
"pattern":"^https://www.soft.tech/blog/"
},
{
"pattern":"^https://www.sofastack.tech/blog/the-next-five-years-of-cloud-native-runtime/"
},
{
"pattern":"^https://github.com/mosn/layotto/blob/f70cdc6196963ad762cf809daf0579403c341def1/spec/proto/runtime/v1/runtime.proto"
},
{
"pattern": "^#"
}
],
"replacementPatterns": [
{
"pattern": "^/",
"replacement": "http://localhost:3000/#/"
"pattern": "^/docs",
"replacement": "/github/workspace/docs/docs"
},
{
"pattern": "^zh/",
"replacement": "http://localhost:3000/#/zh/"
"pattern": "^/img",
"replacement": "/github/workspace/docs/static/img"
},
{
"pattern": "^en/",
"replacement": "http://localhost:3000/#/en/"
}
"pattern": "^start/",
"replacement": "/github/workspace/docs/i18n/en-US/docusaurus-plugin-content-docs/current/start/"
},
{
"pattern": "^community/",
"replacement": "/github/workspace/docs/i18n/en-US/docusaurus-plugin-content-docs/current/community/"
},
{
"pattern": "^component_specs/",
"replacement": "/github/workspace/docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/"
},


],
"timeout": "10s",
"retryOn429": true,
"retryCount": 2,
"fallbackRetryDelay": "10s",
"aliveStatusCodes": [
200,
200,
401
]
}
29 changes: 20 additions & 9 deletions .github/workflows/dead-link-checker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,25 @@ jobs:
steps:
- name: Check out code
uses: actions/checkout@v2
# - name: Install and start docusaurus server
# run: |
# sudo npm install
# sudo npm run build --config docs && nohup npm run serve --config docs &
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
base-branch: main
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
check-modified-files-only: 'yes'
config-file: '.github/dead_link_check_config.json'
folder-path: 'docs/blog/,docs/docs/,docs/i18n/en-US/docusaurus-plugin-content-blog/,docs/i18n/en-US/docusaurus-plugin-content-docs/current/'

- name: Install markdown-link-check
run: sudo npm install -g markdown-link-check@3
# - name: Install markdown-link-check
# run: sudo npm install -g markdown-link-check

- name: Install and start docsify server
run: |
sudo npm i docsify-cli -g
nohup docsify serve docs -p 3000 &
- name: Check dead links in all the .md files
run: make deadlink
# - name: Install and start docusaurus server
# run: |
# sudo npm install
# sudo npm run build --config docs && npm run serve --config docs
# - name: Check dead links in all the .md files
# run: make deadlink
42 changes: 42 additions & 0 deletions .github/workflows/docusaurus-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: CI

on:
push:
branches: [ main ]

jobs:
build:
runs-on: ubuntu-latest
# container: pandoc/latex jj
steps:
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: 18.20.3
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- uses: darrenjennings/algolia-docsearch-action@master
with:
algolia_application_id: 'B0I4Q5CLN8'
algolia_api_key: '478d2fe7bdad5ff46b87f1e8e4662e81'
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 }}
# with:
# source-directory: 'docs/build'
# destination-github-username: 'layotto'
# destination-repository-name: 'layotto.github.io'
# target-branch: main
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ None of these is essential for a pull request, but they will all help.
9. Make sure checks have been correctly passed, you can simply run `make check`
10. Contribute a Pull Request as the rule of Github Workflow, and you should follow the pull request's rules.

> Layotto provides many useful commands to help you contribute easier, please check it [here](docs/en/development/commands.md)
> Layotto provides many useful commands to help you contribute easier, please check it [here](docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/commands.md)
## Version naming convention

Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<h1>Layotto (L8): To be the next layer of OSI layer 7</h1>
<img src="https://raw.githubusercontent.com/mosn/layotto/main/docs/img/logo/grey2-1.svg" height="120px">

[![Layotto Env Pipeline 🌊](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml/badge.svg)](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
[![Layotto Env Pipeline 🌊](https://github.com/mosn/layotto/actions/workflows/proto-checker.yml/badge.svg)](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
[![Layotto Dev Pipeline 🌊](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml/badge.svg)](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)

[![GoDoc](https://godoc.org/mosn.io/layotto?status.svg)](https://godoc.org/mosn.io/layotto)
Expand Down Expand Up @@ -137,15 +137,15 @@ Layotto enriches the <a href="https://landscape.cncf.io/serverless">CNCF CLOUD N
As a programming enthusiast , have you ever felt that you want to participate in the development of an open source project, but don't know where to start?
In order to help everyone better participate in open source projects, our community will regularly publish community tasks to help everyone learn by doing!

[Document Contribution Guide](docs/en/development/contributing-doc.md)
[Document Contribution Guide](docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/contributing-doc.md)

[Component Development Guide](docs/en/development/developing-component.md)
[Component Development Guide](docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-component.md)

[Layotto Github Workflows](docs/en/development/github-workflows.md)
[Layotto Github Workflows](docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/github-workflows.md)

[Layotto Commands Guide](docs/en/development/commands.md)
[Layotto Commands Guide](docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/commands.md)

[Layotto Contributor Guide](docs/en/development/CONTRIBUTING.md)
[Layotto Contributor Guide](docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/CONTRIBUTING.md)

## Contributors

Expand All @@ -157,17 +157,17 @@ Thank y'all!

## Design Documents

[Actuator Design Doc](docs/en/design/actuator/actuator-design-doc.md)
[Actuator Design Doc](docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/actuator/actuator-design-doc.md)

[Configuration API with Apollo](docs/en/design/configuration/configuration-api-with-apollo.md)
[Configuration API with Apollo](docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/configuration/configuration-api-with-apollo.md)

[Pubsub API and Compability with Dapr Component](docs/en/design/pubsub/pubsub-api-and-compability-with-dapr-component.md)
[Pubsub API and Compability with Dapr Component](docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/pubsub/pubsub-api-and-compability-with-dapr-component.md)

[RPC Design Doc](docs/en/design/rpc/rpc-design-doc.md)
[RPC Design Doc](docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/rpc/rpc-design-doc.md)

[Distributed Lock API Design](docs/en/design/lock/lock-api-design.md)
[Distributed Lock API Design](docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/lock/lock-api-design.md)

[FaaS Design](docs/en/design/faas/faas-poc-design.md)
[FaaS Design](docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/faas/faas-poc-design.md)

## FAQ

Expand Down
49 changes: 49 additions & 0 deletions algolia-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"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"
],
"stop_urls": [
"/tests"
],
"selectors": {
"lvl0": {
"selector": "(//ul[contains(@class,'menu__list')]//a[contains(@class, 'menu__link menu__link--sublist menu__link--active')]/text() | //nav[contains(@class, 'navbar')]//a[contains(@class, 'navbar__link--active')]/text())[last()]",
"type": "xpath",
"global": true,
"default_value": "Documentation"
},
"lvl1": "header h1",
"lvl2": "article h2",
"lvl3": "article h3",
"lvl4": "article h4",
"lvl5": "article h5, article td:first-child",
"lvl6": "article h6",
"text": "article p, article li, article td:last-child"
},
"strip_chars": " .,;:#",
"custom_settings": {
"separatorsToIndex": "_",
"attributesForFaceting": [
"language",
"version",
"type",
"docusaurus_tag"
],
"attributesToRetrieve": [
"hierarchy",
"content",
"anchor",
"url",
"url_without_anchor",
"type"
]
},
"conversation_id": [
"833762294"
],
"nb_hits": 46250
}
12 changes: 12 additions & 0 deletions crowdin.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
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/**/*
translation: '/i18n/%locale%/docusaurus-plugin-content-docs/current/**/%original_file_name%'
41 changes: 41 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Loading

0 comments on commit 3d39dd7

Please sign in to comment.