4450182015
docs(api): adapted user API documentation to match with latest API The user API documentation and the actual implementation were out of sync, missing certain newly introduced fields and beeing inconsistent between certain API definitions. The documentation was changed according the actual latest implementation. Signed-off-by: Fabio Huser <fabio@fh1.ch> See merge request !4067 |
||
|---|---|---|
| .. | ||
| administration | ||
| api | ||
| ci | ||
| customization | ||
| development | ||
| downgrade_ee_to_ce | ||
| gitlab-basics | ||
| hooks | ||
| incoming_email | ||
| install | ||
| integration | ||
| intro | ||
| legal | ||
| logs | ||
| markdown | ||
| migrate_ci_to_ce | ||
| monitoring/performance | ||
| operations | ||
| permissions | ||
| profile | ||
| project_services | ||
| public_access | ||
| raketasks | ||
| security | ||
| ssh | ||
| system_hooks | ||
| update | ||
| web_hooks | ||
| workflow | ||
| README.md | ||
README.md
Documentation
User documentation
- API Automate GitLab via a simple and powerful API.
- CI GitLab Continuous Integration (CI) getting started,
.gitlab-ci.ymloptions, and examples. - GitLab as OAuth2 authentication service provider. It allows you to login to other applications from GitLab.
- GitLab Basics Find step by step how to start working on your commandline and on GitLab.
- Importing to GitLab.
- Markdown GitLab's advanced formatting system.
- Migrating from SVN Convert a SVN repository to Git and GitLab
- Permissions Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
- Profile Settings
- 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.
- Webhooks Let GitLab notify you when new code has been pushed to your project.
- Workflow Using GitLab functionality and importing projects from GitHub and SVN.
Administrator documentation
- Authentication/Authorization Configure external authentication with LDAP, SAML, CAS and additional Omniauth providers.
- Custom git hooks Custom git hooks (on the filesystem) for when webhooks aren't enough.
- Install Requirements, directory structures and installation from source.
- Restart GitLab Learn how to restart GitLab and its components
- Integration How to integrate with systems such as JIRA, Redmine, Twitter.
- Issue closing Customize how to close an issue from commit messages.
- Libravatar Use Libravatar for user avatars.
- Log system Log system.
- Environment Variables to configure GitLab.
- Operations Keeping GitLab up and running
- Raketasks Backups, maintenance, automatic webhook setup and the importing of projects.
- Repository checks Periodic Git repository checks
- Security Learn what you can do to further secure your GitLab instance.
- System hooks Notifications when users, projects and keys are changed.
- Update Update guides to upgrade your installation.
- Welcome message Add a custom welcome message to the sign-in page.
- Reply by email Allow users to comment on issues and merge requests by replying to notification emails.
- Migrate GitLab CI to CE/EE Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
- Git LFS configuration
- Housekeeping Keep your Git repository tidy and fast.
- GitLab Performance Monitoring Configure GitLab and InfluxDB for measuring performance metrics
- Sidekiq Troubleshooting Debug when Sidekiq appears hung and is not processing jobs
- High Availability Configure multiple servers for scaling or high availability
Contributor documentation
- Documentation styleguide Use this styleguide if you are contributing to documentation.
- Development Explains the architecture and the guidelines for shell commands.
- Legal Contributor license agreements.