远程办公的GitLab开源的员工手册:涵盖了公司价值观,内部沟通交流指南,开发流程,如何开会,写作风格指南,如何报销,如何请假,线上办公工具推荐等方方面面...

GitLab Community Edition 

GitLab发布的所有在线技术文档,包括:

  • General Documentation
    • 用户文档: 针对使用 GitLab 的普通用文档
    • 管理文档: 针对管理 GitLab 实例的管理文档
    • 贡献文档: 针对 GitLab 开发者和贡献者的文档
  • Topics: pages organized per topic, gathering all the resources already published by GitLab related to a specific subject, including general docs, technical articles, blog posts and video tutorials.
  • GitLab University: Git and GitLab 学习手册。

User documentation 用户文档 

  • 账号安全 使用two-factor等验证方式以确保账号的安全性。
  • API 通过简单而又强大的API实现GitLab自动化。
  • CI/CD GitLab CI可持续集成系统和CD可持续交付系统, .gitlab-ci.yml 参数配置及一些例子。
  • Container Registry 了解如何使用 GitLab Container Registry.
  • Git Attributes 使用 .gitattributes 文件定义该git仓库的属性,(exp. 定义使用哪种语法高亮,哪些文件是二进制文件)。
  • Git cheatsheet备忘录 一个包含了日常使用中较常见的备忘录,PDF格式。
  • 使用GitLab提供OAuth2验证服务 使用GitLab为其他应用的提供身份验证服务。
  • GitLab基础知识 引导你一步一步的使用git命令行走入GitLab的世界。
  • GitLab Pages 教会你如何使用GitLab Pages. 新增
  • 将项目导入GitLab.
  • 不同GitLab实例之间导入导出项目.
  • Importing to GitLab 从托管在 GitHub, Bitbucket, GitLab.com, FogBugz and SVN 上的项目导入到 GitLab 。
  • Markdown GitLab的高级格式化语法。
  • 导入SVN仓库 转换SVN仓库为Git仓库存储到GitLab上。
  • 权限分配 了解项目中的各个角色 (external/guest/reporter/developer/master/owner) 分别拥有什么操作权限。
  • 个性化设置
  • 项目服务 外部服务整合,如CI、聊天系统。
  • 公开访问 了解如何将项目设置为公开访问,或者GitLab内部用户访问。
  • Search through GitLab: 在 Issue Boards 里搜索 issues, merge requests, projects, groups, todos, and issues 。
  • Snippets 你可以在 GitLab 上创建代码片段,类似GitHub的gits。
  • SSH 设置用于安全访问你的项目ssh keys和deploy keys。
  • Webhooks 当项目有新代码 push 进来的时候可以让GitLab通知你。
  • Workflow GitLab 工作流。

Administrator documentation 管理员文档 

  • GitLab访问限制 定义用户可以通过哪些协议访问Gitlab,如限制ssh(即git://)方式访问Gitlab。
  • 身份验证与授权 配置使用LDAP、SAML、CAS外部验证程序以及 如何使用GitLab提供Omniauth授权服务。
  • Container Registry 使用 GitLab 配置 Docker Registry 。
  • 自定义 git hooks 当webhook无法实现某些功能时可使用自定义的git hooks。
  • Debugging Tips Tips to debug problems when things go wrong
  • Environment Variables to configure GitLab.
  • Git LFS configuration 配置 Git LFS 。
  • GitLab Pages configuration 配置 GitLab Pages 。
  • 使用InfluxDB监控GitLab性能 Configure GitLab and InfluxDB for measuring performance metrics.
  • 使用Prometheus监控GitLab性能 Configure GitLab and Prometheus for measuring performance metrics.
  • Header logo Change the logo on the overall page and email header.
  • High Availability Configure multiple servers for scaling or high availability.
  • Housekeeping 整理Git仓库,类似于磁盘的碎片整理功能。
  • 源码安装手册 源码安装需求,源码目录结构。
  • 集成第三方应用 了解如何与其他系统集成,如JIRA、Redmine、Twitter。
  • Issue closing pattern 了解如何定制利用commit信息关闭issue。
  • Koding Set up Koding to use with GitLab.
  • Libravatar 使用Libravatar提供的用户头像服务。
  • 日志系统 日志系统。
  • 把GitLab CI整合到CE/EE 了解如何把已经存在(GitLab8.x版本之前CI是独立的)的GitLab CI数据整合到GitLab CE/EE。
  • Monitoring uptime 在终端使用health check检查服务状态。
  • Operations Keeping GitLab up and running.
  • Polling Configure how often the GitLab UI polls for updates
  • Raketasks 备份、维护、webhook自动安装、导入项目等。
  • Reply by email Allow users to comment on issues and merge requests by replying to notification emails.
  • Repository checks Periodic Git repository checks.
  • Repository storage paths Manage the paths used to store repositories.
  • Request Profiling Get a detailed profile on slow requests.
  • Restart GitLab Learn how to restart GitLab and its components.
  • Security Learn what you can do to further secure your GitLab instance.
  • Sidekiq Troubleshooting Debug when Sidekiq appears hung and is not processing jobs.
  • System hooks Notifications when users, projects and keys are changed.
  • Update Update guides to upgrade your installation.
  • Web terminals Provide terminal access to environments from within GitLab.
  • Welcome message Add a custom welcome message to the sign-in page.

Contributor documentation 代码贡献文档 

  • Development 讲解GitLab的架构以及shell命令指南。
  • 法律声明 贡献者许可协议。

 

 

同类文档: https://thoughtbot.com/playbook

你可能感兴趣的:(远程办公的GitLab开源的员工手册:涵盖了公司价值观,内部沟通交流指南,开发流程,如何开会,写作风格指南,如何报销,如何请假,线上办公工具推荐等方方面面...)