Merge pull request #37 from duanmengkk/main

add auto deploy ci

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,11 @@
+---
+name: Enhancement Request
+about: Suggest an enhancement to the project
+labels: kind/feature
+
+---
+<!-- Please only use this template for submitting enhancement requests -->
+
+**What would you like to be added**:
+
+**Why is this needed**:

.github/ISSUE_TEMPLATE/request-doc.md

@@ -0,0 +1,17 @@
+---
+name: Request Documentation
+about: Request for new documents or supplementation or updating of existing documents. 
+labels: help wanted
+---
+
+**What documentation would you like to be added**:
+
+**Why do you think this document is needed**:
+
+**Where do you think the document should be placed**:
+<!--
+For example: 
+I think the document could be placed under /Documentation/User Guide/xxx/xxx.
+More precisely, the document should be placed in this code directory:
+https://github.com/kosmos-io/kosmos-website/tree/main/docs/userguide/xxx/xxx.md.
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+**What type of PR is this?**
+
+<!--
+Add one of the following kinds:
+
+/kind bug
+/kind cleanup
+/kind design
+/kind documentation
+/kind failing-test
+/kind feature
+/kind flake
+
+-->
+
+**What this PR does / why we need it**:
+
+**Which issue(s) this PR fixes**:
+Fixes #
+
+**Special notes for your reviewer**:
+
+

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/deploy.yml

@@ -0,0 +1,51 @@
+name: 部署到 GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # 如果你想要进一步定义触发、路径以及其他内容，请检阅 Github Actions 文档
+    # https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  build:
+    name: 构建 Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: 安装依赖
+        run: yarn install --frozen-lockfile
+      - name: 构建网站
+        run: yarn build
+
+      - name: 上传构建制品
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    name: 部署到 GitHub Pages
+    needs: build
+
+    # 给予 GITHUB_TOKEN 进行 Pages 部署所必须的权限
+    permissions:
+      pages: write # 以部署到 Pages
+      id-token: write # 以验证部署来自恰当的源
+
+    # 部署到 Github Pages 环境
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: 部署到 GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/test-deploy.yml

@@ -0,0 +1,26 @@
+name: 测试部署
+
+on:
+  pull_request:
+    branches:
+      - main
+    # 如果你想要进一步定义触发、路径以及其他内容，请检阅 Github Actions 文档
+    # https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  test-deploy:
+    name: 测试部署
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: 安装依赖
+        run: yarn install --frozen-lockfile
+      - name: 测试构建网站
+        run: yarn build

.github/workflows/typos.yml

@@ -0,0 +1,15 @@
+name: Typos Check
+on:
+  push:
+  pull_request:
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Check spelling with custom config file
+        uses: crate-ci/[email protected]
+        with:
+          config: ./typos.toml

docs/v0.2.0/proposals/distribution-policy.md

@@ -19,7 +19,7 @@ Kosmos provides a multi-cluster scheduler (kosmos-scheduler) and some scheduling
 [Code](https://github.com/kosmos-io/kosmos/pull/321) responsible for working with DistributionPolicy and ClusterDistributionPolicy CRD API will be imported in the kosmos-scheduler plugins repo. DistributionPolicy is namespace scope and ClusterDistributionPolicy is cluster scope.
 
 #### Filter extension points implementation details
-Since target resources distribution policies are stored in the CRD (DistributionPolicy & ClusterDistributionPolicy), kosmos-scheduler should be subscribed for updates of appropriate CRD type. kosmos-scheduler will use informers which will be generated with the name dpInformer(cdpInformer). CRD will contian in ResourceSelectors and PolicyTerms. ResourceSelectors used to select resources and is required. PolicyTerms represents the rule for select nodes to distribute resources.
+Since target resources distribution policies are stored in the CRD (DistributionPolicy & ClusterDistributionPolicy), kosmos-scheduler should be subscribed for updates of appropriate CRD type. kosmos-scheduler will use informers which will be generated with the name dpInformer(cdpInformer). CRD will contain in ResourceSelectors and PolicyTerms. ResourceSelectors used to select resources and is required. PolicyTerms represents the rule for select nodes to distribute resources.
 
 **Description of the ResourceSelectors rules**
 1. ResourceSelectors is required

src/components/HomepageDescription.js

@@ -8,7 +8,7 @@ function Feature() {
       <div className={styles.leftInfo}>
         <img src="img/feature-info.svg" alt="" />
       </div>
-      <div className={styles.rigthInfo}>
+      <div className={styles.rightInfo}>
         <div className={styles.featureTitle}>What is Kosmos？</div>
         <div className={styles.featuresDes}>
           <p>Kosmos is an open-source, integrated distributed cloud-native solution. The name "kosmos" is formed by combining the "k" representing Kubernetes with "cosmos" from Greek, symbolizing the infinite scalability of Kubernetes.</p>

src/components/HomepageDescription.module.css

@@ -7,7 +7,7 @@
   width: 100%;
 }
 
-.rigthInfo {
+.rightInfo {
   width: 50%;
   display: flex;
   flex-direction: column;

typos.toml

@@ -0,0 +1,14 @@
+# This is the custom config file used by `typos` command and `crate-ci/typos@master` action to do source code spelling correction.
+# Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content.
+# To mark a word or an identifier (grouping of words) as valid, add it to this file by declaring itself as the valid spelling.
+# See https://github.com/crate-ci/typos/blob/master/docs/reference.md for more info to configure typos.
+[files]
+extend-exclude = [
+    "*.svg",
+    "*.drawio",
+]
+[default.extend-words]
+BA = "BA"
+Ded = "Ded"
+EDE = "EDE"
+intoto = "intoto"