mirror of
https://github.com/wahyd4/gitlabhq.git
synced 2026-08-20 10:06:04 +10:00
Achilleas PipinellisandRobert Speicher
ed540c3741
Added documentation for GitLab Metrics This adds documentation for the metrics code I recently added. Two notes: * I'm referring to this feature as "GitLab Metrics" everywhere simply because the code resides in the `Gitlab::Metrics` namespace. A different name is fine, though I think just "Metrics" might be a bit too abstract. * Grafana isn't covered since it's fairly straight-forward to setup (there's nothing really special we can cover). I think we _should_ cover it once we start shipping it with Omnibus. I assigned @axil since he's our technical writer/documentation guru, feel free to re-assign if needed. cc @sytses @axil @dzaporozhets @JobV See merge request !2484
Documentation
User documentation
- API Automate GitLab via a simple and powerful API.
- 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 (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.
- Web hooks Let GitLab notify you when new code has been pushed to your project.
- Workflow Using GitLab functionality and importing projects from GitHub and SVN.
CI Documentation
- Quick Start
- Enable or disable GitLab CI
- Configuring project (.gitlab-ci.yml)
- Configuring runner
- Configuring deployment
- Using Docker Images
- Using Docker Build
- Using Variables
- Using SSH keys
- User permissions
- API
- Triggering builds through the API
CI Languages
CI Services
CI Examples
- Test and deploy Ruby applications to Heroku
- Test and deploy Python applications to Heroku
- Test Clojure applications
- Help your favorite programming language and GitLab by sending a merge request with a guide for that language.
Administrator documentation
- Custom git hooks Custom git hooks (on the filesystem) for when web hooks aren't enough.
- Install Requirements, directory structures and installation from source.
- Integration How to integrate with systems such as JIRA, Redmine, LDAP and 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 web hook setup and the importing of projects.
- 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
- GitLab Performance Monitoring Configure GitLab and InfluxDB for measuring performance metrics
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.
- Release How to make the monthly and security releases.