Skip to content

Commit 95d0df3

Browse files
fslongjinfslongjin
authored
initial commit (#1)
* initial commit * ci: add github pages
1 parent 621ef80 commit 95d0df3

File tree

11 files changed

+268
-1
lines changed

11 files changed

+268
-1
lines changed

‎.github/workflows/deploy.yml

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: Build and Deploy
2+
on:
3+
push:
4+
branches: [ "master"]
5+
pull_request:
6+
branches: [ "master" ]
7+
8+
jobs:
9+
10+
ensure-toolchain:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Setup Node.js environment
16+
uses: actions/[email protected]
17+
with:
18+
node-version: "20.11.0"
19+
20+
- name: Cache dependencies
21+
id: cache-node-modules
22+
uses: actions/cache@v3
23+
env:
24+
cache-name: cache-node-modules
25+
with:
26+
path: ./node_modules
27+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package.json') }}
28+
29+
- name: echo node version
30+
run: node -v
31+
32+
- if: ${{ steps.cache-node-modules.outputs.cache-hit != 'true' }}
33+
name: Install dependencies
34+
continue-on-error: true
35+
run: |
36+
sudo apt update && sudo apt install -y build-essential
37+
source ~/.bashrc
38+
npm install
39+
40+
build:
41+
runs-on: ubuntu-latest
42+
needs: [ensure-toolchain]
43+
steps:
44+
- uses: actions/checkout@v3
45+
46+
- name: Cache dependencies
47+
id: cache-node-modules
48+
uses: actions/cache@v3
49+
env:
50+
cache-name: cache-node-modules
51+
with:
52+
path: ./node_modules
53+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package.json') }}
54+
55+
- name: Setup Node.js environment
56+
uses: actions/[email protected]
57+
with:
58+
node-version: "20.11.0"
59+
60+
- name: echo node version
61+
run: node -v
62+
63+
- name: Build
64+
run: npm run docs:build
65+
66+
deploy:
67+
runs-on: ubuntu-latest
68+
needs: [ensure-toolchain]
69+
environment:
70+
name: github-pages
71+
steps:
72+
- name: Check github secrets
73+
run: sh -c 'if [ -z "${{ secrets.ACTIONS_DEPLOY_KEY }}" ]; then
74+
echo "GitHub Actions deploy key is missing";
75+
exit 1;
76+
fi'
77+
78+
- uses: actions/checkout@v3
79+
80+
- name: Cache dependencies
81+
id: cache-node-modules
82+
uses: actions/cache@v3
83+
env:
84+
cache-name: cache-node-modules
85+
with:
86+
path: ./node_modules
87+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package.json') }}
88+
89+
- name: Setup Node.js environment
90+
uses: actions/[email protected]
91+
with:
92+
node-version: "20.11.0"
93+
94+
- name: Build
95+
run: npm run docs:build
96+
97+
- name: Set CNAME
98+
run: echo 'community.dragonos.org' > ./.vuepress/dist/CNAME
99+
100+
- name: Deploy
101+
uses: peaceiris/actions-gh-pages@v3
102+
with:
103+
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
104+
publish_dir: ./.vuepress/dist

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
node_modules
2+
*.lock
3+
package-lock.json
4+
# VuePress 默认临时文件目录
5+
.vuepress/.temp
6+
# VuePress 默认缓存目录
7+
.vuepress/.cache
8+
# VuePress 默认构建生成的静态文件目录
9+
.vuepress/dist

‎.vuepress/config.js

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
import { viteBundler } from '@vuepress/bundler-vite'
2+
import { defaultTheme } from '@vuepress/theme-default'
3+
import { defineUserConfig } from 'vuepress'
4+
5+
export default defineUserConfig({
6+
bundler: viteBundler(),
7+
8+
theme: defaultTheme(
9+
{
10+
repo: 'DragonOS-Community/community',
11+
repoLabel: 'GitHub',
12+
// 默认是 false, 设置为 true 来启用
13+
editLinks: true,
14+
// 默认为 "Edit this page"
15+
editLinkText: '帮助我们改善此页面！',
16+
smoothScroll: true,
17+
docsBranch: 'master',
18+
logo: '/images/dragonos-full-logo.svg',
19+
nextLinks: true,
20+
navbar: [
21+
{
22+
'text': '首页',
23+
'link': '/',
24+
},
25+
{
26+
'text': '社区治理',
27+
'link': '/governance/',
28+
},
29+
{
30+
'text': '交流',
31+
'link': '/communication/',
32+
},
33+
{
34+
'text': '贡献者',
35+
'link': '/contributors/',
36+
},
37+
{
38+
'text': 'SIGs',
39+
'link': '/sigs/',
40+
},
41+
],
42+
sidebar: {
43+
'/': 'heading',
44+
'/governance/': [
45+
{
46+
text: '社区治理',
47+
children: [
48+
'/governance/',
49+
'/governance/community-membership.md',
50+
]
51+
}
52+
]
53+
}
54+
}
55+
),
56+
lang: 'zh-CN',
57+
title: '',
58+
59+
})

‎.vuepress/public/images/dragonos-full-logo.svg

+1
Loading

‎README.md

+61-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,61 @@
1-
# Community
1+
2+
<div align="center">
3+
<img width="40%" src="/images/dragonos-full-logo.svg" alt="dragonos-logo"></br>
4+
<h2>DragonOS Community</h2>
5+
6+
<a href="https://dragonos.org"><img alt="官网" src="https://img.shields.io/badge/%E5%AE%98%E7%BD%91-DragonOS.org-4c69e4?link=https%3A%2F%2Fbbs.dragonos.org.cn" ></a>
7+
<a href="https://bbs.dragonos.org.cn"><img alt="bbs" src="https://img.shields.io/badge/BBS-bbs.dragonos.org.cn-purple?link=https%3A%2F%2Fbbs.dragonos.org.cn" ></a>
8+
9+
10+
11+
---
12+
13+
</div>
14+
15+
欢迎来到DragonOS社区！
16+
17+
本文是加入并参与DragonOS社区贡献的起点，包括改进文档、改进代码或是参与社区会议等等...
18+
19+
如果您想了解更多关于项目结构以及DragonOS社区的内容，请转到[社区治理]以获取更多的信息！
20+
21+
本文档的在线版本：[community.dragonos.org](community.dragonos.org)
22+
23+
## 交流讨论
24+
25+
[社区交流]页面列出了DragonOS社区的公开交流渠道，如论坛、QQ群、会议等等。
26+
27+
对于更加具体的主题的讨论，请在SIG内进行。
28+
29+
## 社区治理
30+
31+
DragonOS社区官方支持以下类型的团体：
32+
33+
- **委员会** 是一组负责处理敏感话题的人员。社区官方鼓励该小组在能完成其使命的同时，尽可能开放其信息。
34+
但由于所讨论的主题的性质，这些讨论可能会在封闭的群组中进行。委员会的包括社区管理委员会(CMC)、
35+
项目管理委员会(PMC)、法务与合规委员会(LCC)等委员会。
36+
- **特别兴趣小组(SIG)** 是专注于项目的一部分的持续开放团体。特别兴趣小组的程序必须公开透明。
37+
欢迎任何人参与并做出贡献，只要他们遵守 DragonOS 社区行为准则。
38+
SIG 的目的是拥有并开发一组**子项目**。
39+
* **子项目** 每个 SIG 可以有一组子项目。
40+
这些是可以独立工作的较小团体。
41+
* **工作组**是为了解决跨 SIG 边界的问题而成立的临时小组。
42+
工作组不拥有任何代码或其他长期工件。
43+
工作组可以通过相关的 SIG 进行汇报并采取行动。
44+
45+
有关这些组的更多详细信息，请参阅[完整治理文档](governance/README.md)。
46+
47+
## 参与贡献
48+
49+
要参与贡献，第一步是从[DragonOS社区SIG列表](sigs/README.md)中选择一个感兴趣的SIG。参与他们的会议，
50+
加入他们在bbs上的板块。每个SIG通常都会有一些正在进行的，或者等待开发/解决的问题，可以帮助新的贡献者参与其中。
51+
52+
[贡献者指南]介绍了如何让您的想法和bugfix能被看到及接受的详细说明，在参与贡献之前，您应该先阅读它。
53+
54+
## 社区成员资格
55+
56+
我们鼓励所有贡献者成为社区成员。我们的目标是发展一个由贡献者、审阅者和代码维护者组成的活跃、健康的社区。在我们的[社区成员资格]页面中了解有关会员资格要求和责任的更多信息。
57+
58+
[社区治理]: governance/README.md
59+
[社区交流]: communication/README.md
60+
[贡献者指南]: contributors/README.md
61+
[社区成员资格]: governance/community-membership.md

‎communication/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Communication

‎contributors/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 贡献者指南
2+
3+
TODO

‎governance/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Governance
2+
3+
TODO

‎governance/community-membership.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 社区成员资格

‎package.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "community",
3+
"version": "1.0.0",
4+
"description": "",
5+
"main": "index.js",
6+
"scripts": {
7+
"docs:dev": "vuepress dev",
8+
"docs:build": "vuepress build"
9+
},
10+
"repository": {
11+
"type": "git",
12+
"url": "git+https://github.com/DragonOS-Community/Community.git"
13+
},
14+
"author": "",
15+
"license": "GPL-2.0",
16+
"bugs": {
17+
"url": "https://github.com/DragonOS-Community/Community/issues"
18+
},
19+
"homepage": "https://github.com/DragonOS-Community/Community#readme",
20+
"devDependencies": {
21+
"@vuepress/bundler-vite": "^2.0.0-rc.11",
22+
"@vuepress/theme-default": "^2.0.0-rc.30",
23+
"vuepress": "^2.0.0-rc.11"
24+
}
25+
}

‎sigs/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# SIG

0 commit comments

Comments
 (0)