文档说明
对于任何类型的软件来说,良好的文档都是至关重要的。任何能够改进 StreamPark 文档的贡献都是受欢迎的。
获取文档项目
StreamPark 项目的文档在一个单独的 git 仓库 中维护。
首先,您需要将文档项目 fork 到您自己的 github 仓库,然后将文clone
到您的本地计算机。
git clone git@github.com:<your-github-user-name>/incubator-streampark-website
预览和生成静态文件
此网站使用 node 进行编译,使用 Docusaurus 框架组件。
- 下载并安装 nodejs (版本>12.5.0)
- 将代码克隆到本地
git clone git@github.com:apache/incubator-streampark-website.git
- 运行
npm install
来安装所需的依赖库。 - 在根目录中运行
npm run start
,您可以访问 http://localhost:3000 查看站点的英文模式预览 - 在根目录中运行
npm run start-zh
,您可以访问 http://localhost:3000 查看站点的中文模式预览 - 若要生成静态网站资源文件,请运行
npm run build
。构建的静态资源位于 build 目录中。
目录结构
|-- community
|-- docs // 即将发布的下一个版本的文档
|-- download
|-- faq // 常见问题与回答
|-- i18n
| `-- zh-CN // 中文国际化
| |-- code.json
| |-- docusaurus-plugin-content-docs
| |-- docusaurus-plugin-content-docs-community
| |-- docusaurus-plugin-content-docs-download
| |-- docusaurus-plugin-content-docs-faq
| `-- docusaurus-theme-classic
|-- resource // 架构/时序图/流程图等项目源文件
|-- src
| |-- components
| |-- css
| |-- js
| |-- pages
| | |-- home
| | |-- index.jsx
| | |-- team
| | |-- user
| | `-- versions
| |-- styles
|-- static // 图片静态资源
| |-- doc // 文档图片
| |-- user // 用户图片
| |-- home // 主页图片
| |-- img // 通用图片
|-- docusaurus.config.js
规范
目录命名规范
全部小写,由下划线分隔。如果有复数结构,使用复数命名,并且不使用复数缩写。
正例:scripts / styles / components / images / utils / layouts / demo_styles / demo-scripts / img / doc
反例:script / style / demoStyles / imgs / docs
Vue 和静态资源文件的命名规范
全部小写,由破折号分隔。
正例:render-dom.js / signup.css / index.html / company-logo.png
反例:renderDom.js / UserManagement.html
资源路径
图片资源统一放在 static/{模块名称}
下
css 和其他样式文件放在 src/css
目录中。
页面内容修改
除了主页、团队、用户、Docs>所有版本模块页面外,其他所有页面都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。
主页修改
访问页面 https://streampark.apache.org/
位于 src/pages/home
├─home
│ languages.json // 主页中英文配置
│ index.less // 主页样式
团队页面修改
访问页面 https://streampark.apache.org/team
位于 src/pages/team
├─team
│ languages.json
│ index.js
│ index.less
用户列表页面修改
访问页面 https://streampark.apache.org/user
位于 `src/pages/user`
└─versions
data.json
images.json
index.js
index.less
languages.json