Documentation for Teleport Project
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea init. Sep 2, 2018
docs .增加LDAP配置说明。 Dec 17, 2018
themes/readthedocs . Nov 10, 2018
.gitignore 改用mkdocs工具,使用markdown语法编写文档。 Sep 3, 2018
README.md fix a url link. Sep 8, 2018
mkdocs.yml .增加LDAP配置说明。 Dec 17, 2018

README.md

简介

本项目用于生成 docs.tp4a.com 的内容,是 teleport 项目的在线说明文档。

Teleport是一款简单易用的堡垒机系统,具有小巧、易用的特点,支持 RDP/SSH/SFTP/Telnet 协议的远程连接和审计管理。

帮助改进teleport在线说明文档

随着teleport的持续更新,逐渐的会导致文档与实际功能、特性脱节,需要能及时更新。希望你能伸出援手,共同助力teleport的发展。

如何做?

Teleport的在线说明文档使用 mkdocs 工具进行构造,所有文档内容均采用 Markdown 格式,因此,你需要先准备以下环境:

  • Python,建议使用最新版本,例如 miniconda
  • 使用 pip 安装 mkdocs;
  • git 客户端;

以上环境的安装配置可以google或百度,有很多安装配置的说明文档可以参考。

然后呢?

首先你需要从本项目 fork 一个你自己的版本,并且使用git客户端下载到本地。然后在本地修改 docs 目录下的 .md 文件。你需要了解一点 Markdown 的语法,不过相信我,真的很简单。

编辑时,可以打开一个命令行窗口,然后切换到你下载的项目的根目录下,并执行:

mkdocs serve

这样你就可以在浏览器中访问 http://127.0.0.1:8000来实时查看你的编辑成果了。没错,这里说的是实时成果,因为 mkdocs 会监控你的修改,一旦你保存了文件,那么浏览器页面会自动刷新,从而能立刻看到编辑后渲染出来的网页文档。

最后,当你确定修改完成,可以提交你的修改内容到此项目中,具体可以看 github 的 pull-request 的相关说明。如果一切都正常,那么你的修改将会合并到本项目中,并且更新到 docs.tp4a.com 的服务器上,你的编辑成果将会被大家看到,为大家带去帮助!