Doctor:开源文档服务器

Doctor:开源文档服务器


Doctor使用markdown(MD)格式进行文档编写,使用github进行版本控制使用Doctor将来自多个存储库的多个MD文件聚合到一个文档站点中。Doctor根据Apache V2.0许可获得许可。

观看现场演示:http://docs.minio.org.cn/docs/

我们为什么建医生

我们希望文档服务器可以简单地组织和呈现来自github的markdown页面。我们喜欢markdown,因为非开发人员很容易创建/编辑文档。我们需要让社区参与,以使我们的文档变得更好。最后,我们需要一个看起来不像github源存储库的docs网站。在评估了各种框架,CMS解决方案,云托管平台和基于TeX / DocBooks的工具之后,我们最终构建了Doctor。

部署医生

Doctor可以轻松部署在heroku上进行生产,并在本地进行开发。

本地部署

  • 安装Ruby 2.2.2。

  • 安装Rails 4.2.4

  • 安装Postgres并启动Postgres。

  • 在终端中输入以下命令

> git clone https://github.com/minio/doctor.git
> cd doctor
> bundle install
> rake db:drop
> rake db:setup
> rails s

访问http:// localhost:3000

Heroku部署

  • 创建一个新的heroku应用

  • 做一个https://github.com/minio/doctor仓库的分支

  • 使用heroku中的Deploy选项卡,将github分支连接到您的heroku应用程序

  • 单击“部署分支”,根据您的需要成功构建和部署Doctor。

  • 在终端中输入以下命令

> heroku run rake db:drop
> heroku run rake db:setup
  • 在浏览器中访问heroku应用。

管理文件

  • 创建类别。

  • 创建文档。

  • 创建文档时,将完整的原始链接粘贴到github上的MD文件。


1_8EMfRDp0NzTw9bsr2kcvOw.png
将原始链接复制到MD文件


  • 将每个文档与特定类别相关联。保存,您就完成了。


1_lTIYpYu99fdAGW1w0XtMuA.png
指向原始github MD文件并关联一个类别


社区合作

协作是我们的另一个关键要求。在让我们的社区为我们的项目做出贡献时,我们采取不平凡的立场。因此,我们在Doctor中提供了“建议编辑”功能,任何使用我们文档的开发人员都可以通过单击“建议编辑”按钮并向我们发送包含其更改的简单PR来提出更改建议。然后,使用Github工作流程来管理对文档的提交更改。这是我们在Cloud Hosted文档解决方案,内容管理系统或框架中找不到的功能。

客制化

可以从仪表板内编辑项目详细信息并更改项目名称,在页眉和页脚中配置链接。见下面的截图:

品牌定制


1_PGMw-BO3YZEa-77sx4oW2w.png
项目设定


完整的样式指南也可在此处获得

结论

Doctor被设计为最小化。请随时分叉项目。如果您开发了任何出色的功能,请考虑与我们的社区共享这些功能。我们希望看到您的请求请求。

在以下位置贡献给Doctor:https//github.com/minio/doctor

可以在https://github.com/minio/doctor/issues找到医生的增强功能和问题列表


上一篇 下一篇