search

star7th / showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具
https://www.showdoc.com.cn
Other
12.27k stars 2.19k forks source link

新功能需求：所有公开的项目，都可以搜索和查看，不需要登录。 #2278

Open GordonHuangYong opened 1 month ago

GordonHuangYong commented 1 month ago

类似这个界面。

image
star7th commented 1 month ago

这个需求的必要性体现在哪？

star7th commented 1 month ago

使用场景是什么

GordonHuangYong commented 1 month ago

我记得20年有过讨论，后面加上了这个功能，但是仅限登录用户，有权限的用户进行搜索。 我举一个场景：公司有很多技术文档、API、使用说明等，按产品名称放在不同的文件夹。 这些文档是可以公开给销售，客户和第三方开发者去分享和查阅的。 但是平时由各个团队自行管理各自的文档。 按照现有的管理方式， 对于销售、客户和上头来说，就要有各个团队的权限，才能查询，增加了维护者的工作量。 对内还好说，对外部用户就很不方便，需要客服去对接。 市面上的开发者中心，开发文档都是公开汇集在一个文档中心，可公开查询的.

star7th commented 1 month ago

我比较建议，新增一个项目，然后在这项目里，新建几个页面和说明，链接到不同的文档去。这个项目就作为发给外部客户的索引文档。 这样做的好处是，可以自己控制展示什么给客户，以及说明信息。不然的话，默认把全站公开文档都展示，可能某些场景不合适

GordonHuangYong commented 1 month ago

这是一个方案。但是这样子就无法搜索整个站点的内容了。可以参考公开显示和搜索功能。https://github.com/BookStackApp/BookStack/ 它是内置了一个游客角色，没有登录的用户就是这个角色，能搜索查看所有公开的文档。

star7th commented 1 month ago

这个场景，我无法确认是不是有必要的需求。 就我个人而言，我是不想这样子用的，这样我就相当于出官方接口，把公开项目都聚合在一起了，这样爬虫一下子就爬了整站公开数据。实际使用中很多人忘记设置访问密码的。 如果有更多人反馈有这个需求，再考虑改善吧