gitlab-org--gitlab-foss/doc/README.md
2014-12-15 15:17:10 +01:00

2.1 KiB

Documentation

User documentation

  • API Automate GitLab via a simple and powerful API.
  • Markdown GitLab's advanced formatting system.
  • Permissions Learn what each role in a project (guest/reporter/developer/master/owner) can do.
  • Project Services Integrate a project with external services, such as CI and chat.
  • Public access Learn how you can allow public and internal access to projects.
  • SSH Setup your ssh keys and deploy keys for secure access to your projects.
  • Web hooks Let GitLab notify you when new code has been pushed to your project.
  • Workflow Learn how to get the maximum out of GitLab.

Administrator documentation

  • Install Requirements, directory structures and manual installation.
  • Integration How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
  • Raketasks Backups, maintenance, automatic web hook setup and the importing of projects.
  • Custom git hooks Custom git hooks (on the filesystem) for when web hooks aren't enough.
  • System hooks Notifications when users, projects and keys are changed.
  • Security Learn what you can do to further secure your GitLab instance.
  • Update Update guides to upgrade your installation.
  • Welcome message Add a custom welcome message to the sign-in page.
  • Issue closing Customize how to close an issue from commit messages.
  • Libravatar Use Libravatar for user avatars.
  • Operations Keeping GitLab up and running

Contributor documentation

  • Development Explains the architecture and the guidelines for shell commands.
  • Legal Contributor license agreements.
  • Release How to make the monthly and security releases.