You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@seata.apache.org by ji...@apache.org on 2024/08/27 06:26:08 UTC

(incubator-seata-website) branch docusaurus updated: optimize: update CI status (#881)

This is an automated email from the ASF dual-hosted git repository.

jimin pushed a commit to branch docusaurus
in repository https://gitbox.apache.org/repos/asf/incubator-seata-website.git


The following commit(s) were added to refs/heads/docusaurus by this push:
     new 44757694f6 optimize: update CI status (#881)
44757694f6 is described below

commit 44757694f694daca89d8412cce271a00f7e2f268
Author: jimin <sl...@163.com>
AuthorDate: Tue Aug 27 14:26:04 2024 +0800

    optimize: update CI status (#881)
---
 .github/workflows/{CI.yml => build.yml} |  2 +-
 README.md                               | 56 ++++++++++++++++-----------------
 2 files changed, 29 insertions(+), 29 deletions(-)

diff --git a/.github/workflows/CI.yml b/.github/workflows/build.yml
similarity index 97%
rename from .github/workflows/CI.yml
rename to .github/workflows/build.yml
index a714fe941a..f5978c432e 100644
--- a/.github/workflows/CI.yml
+++ b/.github/workflows/build.yml
@@ -1,4 +1,4 @@
-name: CI
+name: "build"
 
 on:
   pull_request:
diff --git a/README.md b/README.md
index 55090650bc..5c1963a002 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Seata Official Website
 
-[![CI Status](https://github.com/apache/incubator-seata-website/workflows/CI/badge.svg)](https://github.com/apache/incubator-seata-website/actions)
+[![CI Status](https://github.com/apache/incubator-seata-website/workflows/build/badge.svg?branch=docusaurus)](https://github.com/apache/incubator-seata-website/actions)
 
 All website material of [https://seata.apache.org](https://seata.apache.org), which uses a open source framework: Docusaurus.
 
@@ -37,7 +37,7 @@ localhost:3000/
 
 ## Requirements
 
-Base docusaurus **2.4.1**  
+Base docusaurus **2.4.1**
 Node.js version **19.5.0**
 
 ## Note for i18n
@@ -51,28 +51,28 @@ We use the **Docusaurus internationalization (i18n)** to support both English(en
 Our website stucture with i18n and versioning looks like below:
 
 ```text
-website  
+website
 ├── sidebars.json        # sidebar for the current docs version
 ├── docs                 # docs directory for the current docs version
-│   ├── foo  
-│   │   └── bar.md       # https://mysite.com/docs/next/foo/bar  
-│   └── hello.md         # https://mysite.com/docs/next/hello  
+│   ├── foo
+│   │   └── bar.md       # https://mysite.com/docs/next/foo/bar
+│   └── hello.md         # https://mysite.com/docs/next/hello
 ├── versions.json        # file to indicate what versions are available
-├── versioned_docs  
-│   ├── version-1.1.0  
-│   │   ├── foo  
-│   │   │   └── bar.md   # https://mysite.com/docs/foo/bar  
-│   │   └── hello.md  
-│   └── version-1.0.0  
-│       ├── foo  
-│       │   └── bar.md   # https://mysite.com/docs/1.0.0/foo/bar  
-│       └── hello.md  
-├── versioned_sidebars  
-│   ├── version-1.1.0-sidebars.json  
-│   └── version-1.0.0-sidebars.json  
-├── blog 
-├── docusaurus.config.js  
-├── package.json  
+├── versioned_docs
+│   ├── version-1.1.0
+│   │   ├── foo
+│   │   │   └── bar.md   # https://mysite.com/docs/foo/bar
+│   │   └── hello.md
+│   └── version-1.0.0
+│       ├── foo
+│       │   └── bar.md   # https://mysite.com/docs/1.0.0/foo/bar
+│       └── hello.md
+├── versioned_sidebars
+│   ├── version-1.1.0-sidebars.json
+│   └── version-1.0.0-sidebars.json
+├── blog
+├── docusaurus.config.js
+├── package.json
 ├── i18n
 │   ├── en
 │   │   ├── docusaurus-plugin-content-docs
@@ -94,20 +94,20 @@ website
 
 ### Directories Related to Adding Documents
 
-docs - Contain the current (latest version) documents (placeholder for sidebar indexing purposes)  
+docs - Contain the current (latest version) documents (placeholder for sidebar indexing purposes)
     Document Content should be `Placeholder. DO NOT DELETE.`
 
 sidebars.json - Set the sidebar for the current (latest version) documents.
 
-versioned_docs - Contain the previous version documents (placeholder for sidebar indexing purposes)  
+versioned_docs - Contain the previous version documents (placeholder for sidebar indexing purposes)
     Document Content should be `Placeholder. DO NOT DELETE.`
 
 versioned_sidebars - Set the sidebar for the specific previous versions documents.
 
-i18n-`en`-docusaurus-plugin-content-docs-`current` - Contain the actual **latest version** English documents.  
+i18n-`en`-docusaurus-plugin-content-docs-`current` - Contain the actual **latest version** English documents.
 i18n-`en`-docusaurus-plugin-content-docs-`version-1.0.0` - Contain the actual **1.0.0 version** English documents.
 
-i18n-`zh-cn`-docusaurus-plugin-content-docs-`current` - Contains the actual **latest version** Simplified Chinese documents.  
+i18n-`zh-cn`-docusaurus-plugin-content-docs-`current` - Contains the actual **latest version** Simplified Chinese documents.
 i18n-`zh-cn`-docusaurus-plugin-content-docs-`version-1.0.0` - Contain the actual **1.0.0 version** Simplified Chinese documents.
 
 ### Summary of Adding Documents
@@ -134,12 +134,12 @@ We don't have a versioned blog, so it's easier to add a blog. When adding a new
 
 ### Directories Related to Adding Blogs
 
-blog - Contain the blogs(placeholder for blog sidebar indexing purposes)  
+blog - Contain the blogs(placeholder for blog sidebar indexing purposes)
     Blog Content should be `Placeholder. DO NOT DELETE.`
 
-i18n-`en`-docusaurus-plugin-content-blog - Contain all the actual English blogs.  
+i18n-`en`-docusaurus-plugin-content-blog - Contain all the actual English blogs.
 
-i18n-`zh-cn`-docusaurus-plugin-content-blog - Contain all the actual Simplified Chinese blogs.  
+i18n-`zh-cn`-docusaurus-plugin-content-blog - Contain all the actual Simplified Chinese blogs.
 
 ### Summary of Adding Blogs
 


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@seata.apache.org
For additional commands, e-mail: notifications-help@seata.apache.org