简介
thingsboard.io是我们的开源网站你可以在仓库中找到代码而且每一个人都可以为网站做贡献。
分支
如果你不熟悉GitHub请在继续之前阅读本文档之前询问具有专业知识的同事，如果已经具备相关知识确保您已经拥有GitHub帐户并且已成功登录。
- [步骤 1] 请参考Git文档在计算机上进行安装。
- [步骤 2] 通过SSH连接到GitHub。
- [步骤 3] 打开thingsboard.github.io。
-
[步骤 4] 参阅分支文档建立thingsboard.github.io项目。
现在你的私有GitHub存储库中拥有网站的副本。
本地部署
现在可以在本地计算机上启动并查看网站的最新版本，thingsboard.io基于jekyll生成的因此在本地主机上运行网站需要安装一个jekyll服务器。
以下命令设置用于在本地运行GitHub页面的环境所做的任何编辑都将在本地计算机上运行的轻量级Web服务。
请运行以下命令在Ubuntu 20.04.1 LTS安装Ruby 2.2或更高版本：
1
2
3
4
5
6
sudo apt-get install software-properties-common
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install make ruby ruby-dev libffi-dev g++ zlib1g-dev
sudo gem install github-pages
sudo gem install jekyll bundler
克隆网站：
1
git clone https://github.com/thingsboard/thingsboard.github.io.git
如果要在本地查看或更改请执行以下操作：
1
2
3
cd thingsboard.github.io
bundle install
bundle exec jekyll serve --host 0.0.0.0
执行以下命令更改网站结构：
1
rm -rf _site .jekyll-metadata && bundle exec jekyll serve --host 0.0.0.0
在项目根目录执行以下脚本：
1
./restart.sh
通过http://localhost:4000查看网站效果。
集成指南
使用示例作为指南基础页面位于”/docs/samples/sample/sample.md”打开.md文件后执行每一步。
- [步骤 1] 添加文档目录”/docs/samples/YOUR_INTEGRATION_NAME/”。
- [步骤 2] 添加图片目录”/images/samples/YOUR_INTEGRATION_NAME/”。
- [步骤 3] 使用[步骤1]中示例创建”YOUR_INTEGRATION_NAME.md”文件。
- [步骤 4] 将图片存放于”/images/samples/YOUR_INTEGRATION_NAME/”目录中。
- [步骤 5] 添加logo到”/images/partners/”目录中。
-
[步骤 6] 添加访问路径在”partners.json”文件中在”/_includes/”添加logo并插入以下代码。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
{ "type": "hardware", "program": "", "name": "YOUR_INTEGRATION_NAME", "logo": "YOUR_LOGO.png", "links": { "Site": { "href": "https://www.YOUR_SITE.com/", "target": "_blank" }, "Integration guide": { "href": "/docs/samples/PATH_TO_YOUR_GUIDE-FILE_FROM_STEP_3/GUIDE-FILE/" } }, "blurb": "YOUR_INTEGRATION_DESCRIPTION." }
说明：
1
2
3
4
"YOUR_INTEGRATION_NAME" - 集成指南名称
"YOUR_LOGO.png" -集成的公司和logo文件
"https://www.YOUR_SITE.com/" - 集成指南访问地址
"/docs/samples/PATH_TO_YOUR_GUIDE-FILE_FROM_STEP_3/GUIDE-FILE/" - 完整路径名
提匀
可选步骤
通过联系我们通知我们合并你的请求（带有合并请求#）。
