二、运维项目实战(迁移中)
最后更新于:2022-04-02 07:47:10
### 部署手册要求
- 包含业务基础
- 功能介绍
- 基本部署手册
- 包含模拟案例
- 按照部署手册要求
### 文档基本原则
- #### 面向初级运维人员编写文档,禁止面向0基础(系统运维0基础)
- #### 禁止突出显示(标红、加粗)重要提示(不认真看文档,活该踩坑)
- #### 禁止过多描述基础(没基础补充一下再看)
- #### 引用他人文章要在文档开始 **加粗注明(使用####)**作者和引用地址
`例: #### [原文地址](http://www.cnblogs.com/reblue520/p/6874925.html "原文地址"),非常感谢郑子明的分享。`
- #### 配置文件、报错及日志,统一放置在文档结尾或单独建立一章节,保持文档简洁
- #### 文档上传前必须脱敏(密码替换、主机名替换、实例名替换),避免不必要的麻烦
#### 基本介绍要求
1. 功能介绍或官方文档链接
2. 适用场景
3. 基本部署
#### 部署手册要求
1. 环境介绍(主机名、IP、配置、端口作用、拓扑图),表格呈现
2. 如果表格内容较多,可拆分为两个表格
3. 配置文件和注释
4. 根据不同场景部署
#### 命令执行要求
```shell
用``` ```包含
命令注释用#开头
```
举例
```shell
#进入/opt目录,解压后移至/usr/local/下
cd /opt
tar xzf Mycat-server-1.6-RELEASE-20161028204710-linux.tar.gz
mv mycat /usr/local/
```
#### 文档目录层级
```shell
一、
1.1
1.1.1
1.
```
举例
```shell
三、MySQL运维笔记
1.1 MySQL高可用
1.1.1 MyCAT
1. MyCAT基础
```
#### 笔记层级(markdown)
```shell
### 第一层级(功能介绍、业务部署、原理机制)
#### 第二层级(应用场景、主要特性、优缺点)
##### 第三层级(主要步骤、原理分类、场景分类)
```
举例:
```shell
### Zookeeper服务部署
#### 伪集群方式部署
##### 依赖环境部署
##### Zookeeper部署
##### 配置文件调整
##### 服务器启动
```
###
';