从0到1 手把手搭建spring cloud alibaba 微服务大型应用框架(七) 开发环境使用轻量级在线文档解决知识分享问题

本文涉及的产品
注册配置 MSE Nacos/ZooKeeper,118元/月
云原生网关 MSE Higress,422元/月
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
简介: 从0到1 手把手搭建spring cloud alibaba 微服务大型应用框架(七) 开发环境使用轻量级在线文档解决知识分享问题

题外话


有没有过想看某个项目资料或者接口或者文档资料等怎么都找不到的精力,或者有一堆文档,但是不知道自己想要找的内容在哪个文档里?恭喜你不要999,也不要99 ,只要0.0元 在线文档送到家 ( ^_^ )


本节本身和mini cloud 框架本身关系不大,但是和每个人都有着紧密联系,毕竟每个人的开发都离不开框架文档,接口文档,详设文档等,这节主要是给大家分享一个轻量级适合中小团队和公司得在线文档系统 mrDoc  

1.png 进入正题


什么才算是在线文档系统,为什么要使用在线文档


首先我们来聊一下为什么开发环境需要一个在线文档系统,聊之前首先我们得确认一下什么是在线文档系统,是不是一个地址文档可以下载就算在线文档系统了呢,我个人觉得,算也不算,这个得看具体使用场景,如果说文档明细已经做的很好了,有一个文档明确记录了哪个文档得下载地址以及划分明确,并且变动不大的情况下,其实是可以满足一般需求得,但是如果文档是一个生命周期的过程中而不是结束了归档了,那么其实是不符合在线文档系统需求的,我觉得一般需要具备以下特点:

### 1.可以在线编辑,预览,最好可以支持word 格式上传
### 2.可以进行版本管理与对比
### 3.可以进行权限控制,也就是哪些角色可以对这个文档做什么事
### 4.可以对文档进行父子关系或者关联关系管理
### 5.可以全文检索

我觉得具备了以上特点的才可称之为在线文档系统,我们很多开发环境用git或者svn进行文档管理,它具备了共享,在线预览权限管理等特点,但是对都是基于目录层级或者项目级别的,不具备父子关联关系管理,所以我觉得不算是在线文档系统


目前比较常用的在线文档


### 说了这么多,那市面上比较常用的一些在线文档是哪些呢
### gitbook: 其实github,gitlab本身就自持自家系列的文档系统gitbook,而且功能强大,和git无缝对接,但是我觉得就是因为追求通用以及功能强大
### 导致了过于重,如果是大型团队或者公司我比较推荐这个
### wiki:是国内外比较通用的文档系统,但是一样操作繁琐复杂度高,我觉得如果中小公司或者团队可以选择我推荐的mrDoc
### lanhu:蓝狐一般是针对前端的,但是其实可以作为在线文档系统去使用,但是无法私有部署
### 语雀:和蓝狐一样,都挺好就是无法私有化部署
### mrDoc:今天主要我推荐的就是这个,很轻量,但是该有的功能都有,操作符合国人习惯

mrDoc 优缺点


### 优点:可以在线预览编辑,也支持多格式编辑,还有支持导入导出功能,可以全文检索,也具备权限管理功能,还有桌面客户端,还可以进行独立得素材管理,最重要的是很轻量,部署也方便
### 缺点:由于刚刚起部,权限管理以及下载格式支持的还够完善

mrDoc docker部署开源版


一、拉取 MrDoc 代码
进入目录:
cd /opt
开源版:
git clone https://gitee.com/zmister/MrDoc.git
二、获取 Docker 镜像
方式一:拉取镜像
docker pull zmister/mrdoc:v4
三、运行 Docker 容器
开源版:
docker run -d --name mrdoc -p 10086:10086 -v /opt/MrDoc:/app/MrDoc zmister/mrdoc:v4
四、管理
创建管理员账户
docker exec -it mrdoc python manage.py createsuperuser
修改用户密码
docker exec -it mrdoc python manage.py changepassword 用户名
停止容器
docker stop mrdoc
启动容器
docker start mrdoc
删除容器
docker rm -f mrdoc

部署后访问服务器ip +端口号10086,首页如下

1.png

mrDoc 使用 ,以下列举几个常用功能


创建文集:如果按照项目管理的话,一般就是一个项目创建一个文集,如图是我们项目即将启动之前我对项目创建了一个文集,然后放上去一些共通文档和开发文档,因为需求还在调研,所以还没放需求文档和逻辑文档


1.png

创建文档:文档隶属于某个文集,也可以设置其他文档为自己的父类,最终形成树形结构


个人中心:在里面可以管理自己的文档以及一些属性


1.png

后台管理:如果是超级管理员,则可以进行其他文档的管理,也可以进行用户管理等


1.png


总结:如果是中小行公司或者团队,推荐使用mrDoc,确实好用~

相关文章
|
11天前
|
Dubbo Java 应用服务中间件
Spring Cloud Dubbo:微服务通信的高效解决方案
【10月更文挑战第15天】随着信息技术的发展,微服务架构成为企业应用开发的主流。Spring Cloud Dubbo结合了Dubbo的高性能RPC和Spring Cloud的生态系统,提供高效、稳定的微服务通信解决方案。它支持多种通信协议,具备服务注册与发现、负载均衡及容错机制,简化了服务调用的复杂性,使开发者能更专注于业务逻辑的实现。
30 2
|
17天前
|
XML JSON API
ServiceStack:不仅仅是一个高性能Web API和微服务框架,更是一站式解决方案——深入解析其多协议支持及简便开发流程,带您体验前所未有的.NET开发效率革命
【10月更文挑战第9天】ServiceStack 是一个高性能的 Web API 和微服务框架,支持 JSON、XML、CSV 等多种数据格式。它简化了 .NET 应用的开发流程,提供了直观的 RESTful 服务构建方式。ServiceStack 支持高并发请求和复杂业务逻辑,安装简单,通过 NuGet 包管理器即可快速集成。示例代码展示了如何创建一个返回当前日期的简单服务,包括定义请求和响应 DTO、实现服务逻辑、配置路由和宿主。ServiceStack 还支持 WebSocket、SignalR 等实时通信协议,具备自动验证、自动过滤器等丰富功能,适合快速搭建高性能、可扩展的服务端应用。
75 3
|
14天前
|
Dubbo Java 应用服务中间件
Dubbo学习圣经:从入门到精通 Dubbo3.0 + SpringCloud Alibaba 微服务基础框架
尼恩团队的15大技术圣经,旨在帮助开发者系统化、体系化地掌握核心技术,提升技术实力,从而在面试和工作中脱颖而出。本文介绍了如何使用Dubbo3.0与Spring Cloud Gateway进行整合,解决传统Dubbo架构缺乏HTTP入口的问题,实现高性能的微服务网关。
|
11天前
|
JSON Java 数据格式
【微服务】SpringCloud之Feign远程调用
本文介绍了使用Feign作为HTTP客户端替代RestTemplate进行远程调用的优势及具体使用方法。Feign通过声明式接口简化了HTTP请求的发送,提高了代码的可读性和维护性。文章详细描述了Feign的搭建步骤,包括引入依赖、添加注解、编写FeignClient接口和调用代码,并提供了自定义配置的示例,如修改日志级别等。
30 1
|
14天前
|
人工智能 文字识别 Java
SpringCloud+Python 混合微服务,如何打造AI分布式业务应用的技术底层?
尼恩,一位拥有20年架构经验的老架构师,通过其深厚的架构功力,成功指导了一位9年经验的网易工程师转型为大模型架构师,薪资逆涨50%,年薪近80W。尼恩的指导不仅帮助这位工程师在一年内成为大模型架构师,还让他管理起了10人团队,产品成功应用于多家大中型企业。尼恩因此决定编写《LLM大模型学习圣经》系列,帮助更多人掌握大模型架构,实现职业跃迁。该系列包括《从0到1吃透Transformer技术底座》、《从0到1精通RAG架构》等,旨在系统化、体系化地讲解大模型技术,助力读者实现“offer直提”。此外,尼恩还分享了多个技术圣经,如《NIO圣经》、《Docker圣经》等,帮助读者深入理解核心技术。
SpringCloud+Python 混合微服务,如何打造AI分布式业务应用的技术底层?
|
21天前
|
负载均衡 算法 Nacos
SpringCloud 微服务nacos和eureka
SpringCloud 微服务nacos和eureka
49 0
|
2月前
|
安全 应用服务中间件 API
微服务分布式系统架构之zookeeper与dubbo-2
微服务分布式系统架构之zookeeper与dubbo-2
|
2月前
|
负载均衡 Java 应用服务中间件
微服务分布式系统架构之zookeeper与dubbor-1
微服务分布式系统架构之zookeeper与dubbor-1
|
3月前
|
Kubernetes Cloud Native Docker
云原生之旅:从容器到微服务的架构演变
【8月更文挑战第29天】在数字化时代的浪潮下,云原生技术以其灵活性、可扩展性和弹性管理成为企业数字化转型的关键。本文将通过浅显易懂的语言和生动的比喻,带领读者了解云原生的基本概念,探索容器化技术的奥秘,并深入微服务架构的世界。我们将一起见证代码如何转化为现实中的服务,实现快速迭代和高效部署。无论你是初学者还是有经验的开发者,这篇文章都会为你打开一扇通往云原生世界的大门。
|
3月前
|
负载均衡 应用服务中间件 持续交付
微服务架构下的Web服务器部署
【8月更文第28天】随着互联网应用的不断发展,传统的单体应用架构逐渐显露出其局限性,特别是在可扩展性和维护性方面。为了解决这些问题,微服务架构应运而生。微服务架构通过将应用程序分解成一系列小型、独立的服务来提高系统的灵活性和可维护性。本文将探讨如何在微服务架构中有效部署和管理Web服务器实例,并提供一些实际的代码示例。
97 0