Skip to content

Commit 024a3e4

Browse files
GuangmingLuoGuangmingLuo
committed
Initial deployment cleanup
0 parents  commit 024a3e4

2,001 files changed

Lines changed: 213979 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Editor configuration, see https://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.{css,scss,js,html,json,toml,yaml}]
12+
indent_style = space
13+
indent_size = 2
14+
15+
[*.{md,txt,sh}]
16+
indent_style = space
17+
indent_size = 4
18+
19+
[*.md]
20+
trim_trailing_whitespace = false
21+
22+
[Makefile]
23+
indent_style = tab

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# For more information, please refer to https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
2+
3+
* @cloudwego/website-docs-reviewers @cloudwego/website-docs-approvers @cloudwego/website-docs-maintainers

‎.github/ISSUE_TEMPLATE/DOCS_UPDATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Documentation Issue
3+
about: You've found an issue with the documentation.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**What needs to be changed?** Describe the update that is required.
10+
11+
**What is the name + path of the page that needs changed?** The relative path
12+
and page title where you found a problem.
13+
14+
**Additional context**: anything else you can think about that would be helpful.
15+
16+
_Please delete paragraphs that you did not use before submitting._

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Website Feature Request
3+
about: For things we should add or change on the site.
4+
title: ''
5+
labels: feature request
6+
assignees: ''
7+
---
8+
9+
**Desired feature or idea**: What would you like to see happen?
10+
11+
**Additional context**: anything else you can think about that would be helpful.
12+
13+
_Please delete paragraphs that you did not use before submitting._

‎.github/ISSUE_TEMPLATE/ISSUE_REPORT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Website Issue/Bug
3+
about: For reporting a problem with the cloudwego.io site.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**What happened?** Describe the problem that occurred.
10+
11+
**What did you expect would happen?** Describe the expected result/output.
12+
13+
**What is the name + path of the page where you encountered the issue?** The
14+
relative path and page title where you found a problem.
15+
16+
**What browser, OS, and platform were you using when you encountered the
17+
problem?** Include the browser version if you know it as well.
18+
19+
**Additional context**: anything else you can think about that would be helpful.
20+
21+
_Please delete paragraphs that you did not use before submitting._

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
#### What type of PR is this?
2+
<!--
3+
Add one of the following kinds:
4+
5+
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
6+
ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
7+
docs: Documentation only changes
8+
feat: A new feature
9+
optimize: A new optimization
10+
fix: A bug fix
11+
perf: A code change that improves performance
12+
refactor: A code change that neither fixes a bug nor adds a feature
13+
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc)
14+
test: Adding missing tests or correcting existing tests
15+
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
16+
-->
17+
18+
#### Check the PR title.
19+
<!--
20+
The description of the title will be attached in Release Notes,
21+
so please describe it from user-oriented, what this PR does / why we need it.
22+
Please check your PR title with the below requirements:
23+
-->
24+
- [ ] This PR title match the format: \<type\>(optional scope): \<description\>
25+
- [ ] The description of this PR title is user-oriented and clear enough for others to understand.
26+
27+
28+
#### (Optional) Translate the PR title into Chinese.
29+
30+
31+
#### (Optional) More detailed description for this PR(en: English/zh: Chinese).
32+
<!--
33+
Provide more detailed info for review(e.g., it's recommended to provide perf data if this is a perf type PR).
34+
-->
35+
en:
36+
zh(optional):
37+
38+
39+
#### (Optional) Which issue(s) this PR fixes:
40+
<!--
41+
Automatically closes linked issue when PR is merged.
42+
Eg: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
43+
-->

‎.github/workflows/deploy-cn.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: cloudwego.cn deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
env:
8+
OSS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEYID }}
9+
OSS_ACCESS_KEY_SECRET: ${{ secrets.ACCESS_KEYSECRET }}
10+
OSS_REGION: cn-beijing
11+
12+
jobs:
13+
deploy:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
submodules: recursive
19+
fetch-depth: 0
20+
ref: main
21+
- name: Setup Hugo
22+
uses: peaceiris/actions-hugo@v3
23+
with:
24+
hugo-version: "0.151.0"
25+
extended: true
26+
- name: Setup Node
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: "22"
30+
31+
- name: Cache dependencies
32+
uses: actions/cache@v4
33+
with:
34+
path: ~/.npm
35+
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
36+
restore-keys: |
37+
${{ runner.os }}-node-
38+
- run: npm install
39+
- run: HUGO_ENV=production hugo --minify -b http://cloudwego.cn
40+
- name: setup-ossutil2
41+
uses: rogerogers/setup-ossutil2@v1.0.0
42+
- name: upload to oss
43+
run: ossutil sync public/ oss://cloudwego-website-cn/ --delete -f

‎.github/workflows/gh-page.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: github pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
submodules: recursive
18+
fetch-depth: 0
19+
ref: main
20+
21+
- name: Setup Hugo
22+
uses: peaceiris/actions-hugo@v3
23+
with:
24+
hugo-version: "0.151.0"
25+
extended: true
26+
27+
- name: Setup Node
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: "22"
31+
32+
- name: Cache dependencies
33+
uses: actions/cache@v4
34+
with:
35+
path: ~/.npm
36+
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
37+
restore-keys: |
38+
${{ runner.os }}-node-
39+
- run: npm install
40+
- run: HUGO_ENV=production hugo --minify
41+
42+
- name: Deploy
43+
uses: peaceiris/actions-gh-pages@v4
44+
if: github.ref == 'refs/heads/main'
45+
with:
46+
github_token: ${{ secrets.GITHUB_TOKEN }}
47+
publish_dir: ./public

‎.github/workflows/push-check.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Push Check
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
11+
- name: typos-action
12+
uses: crate-ci/typos@v1.32.0

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
public/
3+
resources/
4+
node_modules/
5+
tech-doc-hugo
6+
7+
# vim temporary files
8+
*~
9+
*.sw?
10+
11+
# system files
12+
.DS_Store
13+
14+
# IDE files
15+
.idea
16+
.vscode
17+
.trae
18+
19+
# hugo
20+
.hugo_build.lock
21+
22+
# lock file
23+
package-lock.json
24+
pnpm-lock.yaml

0 commit comments

Comments
 (0)