MOSN 文档使用指南

2018 年，MOSN 开源以来，随着各种需求的迭代、更新，逐渐导致官网文档存在比较多缺失，新功能的实现未能及时更新，原有功能不断重构、优化调整，导致文档描述也不那么准确了。

MOSN 在不断开源，影响力也在增加，拥有更多用户。很多新加入的社区同学，使用时发现文档与项目不匹配。为了配合 MOSN1.0 的发布，打造成熟稳定的社区生态，降低新用户的学习成本，让 MOSN 更易上手。

更新旧文档、填补缺失文档迫在眉睫！

查看文档 👉 https://mosn.io/docs/

完善配置文件

配置文件的说明是最基础的部分，由于各种需求的迭代、更新，以前很多配置只是相当小一部分的子集。

我们首要任务补全配置文件，使新用户从配置文档快速了解 MOSN 。而不像之前一样配置文件只有一部分，剩下的怎么配只能去代码里面看。

详细描述快速开始

以前的快速开始不太仔细，略过一些我们自认为简单的步骤。这种主观性的判断使新手照着文档来做操作不顺畅，导致文档体验不好。

目前我们的快速开始完全是一步一步、手把手教学，你按照文档步骤做下去，一定能得到预期的结果。

整理文档框架

我们对博客上的文章进行了架构上的调整以及重新组织。在官网上看起来会更直观一些，用户能够快速找到自己的目标文章。

新手如何使用 MOSN 文档呢？

 一、学习模型

如果对 MOSN 有些兴趣，想了解模型怎么用。可以根据我们文档快速开始的内容，方便快捷在本地把 MOSN 跑起来。

另外，我们还提供了在线教程的能力，一些本地的搭建比较麻烦，可以通过在线教程，进行简单步骤，就能够完成教程里演示的基本能力的运行，第一时间体验到各个功能的价值。

二、直接使用能力

更进一步的用户抱着某种实际的诉求而来，需要用网络代理来满足需求，可以看我们的配置文档。查看相关配置，了解通过什么样的配置，能够完成对应的能力。

三、二次开发扩展能力

在开源社区，MOSN 是一个比较通用的网络代理。在实际的生产场景，从商业化角度来说，在其他公司的落地，首先要了解 MOSN 的二次开发的扩展能力。

- 通过文档里面扩展能力的介绍——具备哪些扩展能力、如何扩展、如何编写相关的代码、快速的集成；

- 更进一步可以看源码解析文章，了解更深入的原理。

在模型通用能力的基础上，基于扩展能力，完成自己独有诉求的开发，也更契合深度用户的诉求。

希望大家都能通过优化后的文档，快速获取所需。

如果你对我们的文档有什么建议和需求

欢迎在该条 issue 下留言 👏

https://github.com/mosn/mosn/issues/2023

   本周推荐阅读