Commit f22c7095 authored by Marin Jankovski's avatar Marin Jankovski

Add titles to doc pages.

parent 3bdf0e29
## Deploy Keys # Deploy Keys
### List deploy keys ### List deploy keys
......
# Groups
## List project groups ## List project groups
Get a list of groups. (As user: my groups, as admin: all groups) Get a list of groups. (As user: my groups, as admin: all groups)
......
# Issues
## List issues ## List issues
Get all issues created by authenticated user. This function takes pagination parameters Get all issues created by authenticated user. This function takes pagination parameters
......
# Merge requests
## List merge requests ## List merge requests
Get all merge requests for this project. Get all merge requests for this project.
......
# Milestones
## List project milestones ## List project milestones
Returns a list of project milestones. Returns a list of project milestones.
......
# Notes
Notes can be wall notes or comments on snippets, issues or merge requests. Notes can be wall notes or comments on snippets, issues or merge requests.
## Wall ## Wall
......
# Project snippets
## List snippets ## List snippets
Get a list of project snippets. Get a list of project snippets.
......
## Projects # Projects
### List projects ### List projects
......
# Repositories
## List project repository tags ## List project repository tags
Get a list of repository tags from a project, sorted by name in reverse alphabetical order. Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
......
# CRUD for repository files # Repository files
## CRUD for repository files
## Create, read, update and delete repository files using this API ## Create, read, update and delete repository files using this API
......
# Session
Login to get private token Login to get private token
``` ```
......
# System hooks
All methods require admin authorization. All methods require admin authorization.
The url endpoint of the system hooks can be configured in [the admin area under hooks](/admin/hooks). The url endpoint of the system hooks can be configured in [the admin area under hooks](/admin/hooks).
......
# Users
## List users ## List users
Get a list of users. Get a list of users.
......
# Database Mysql
## Note ## Note
We do not recommend using MySQL due to various issues. For example, case [(in)sensitivity](https://dev.mysql.com/doc/refman/5.0/en/case-sensitivity.html) and [problems](http://bugs.mysql.com/bug.php?id=65830) that [suggested](http://bugs.mysql.com/bug.php?id=50909) [fixes](http://bugs.mysql.com/bug.php?id=65830) [have](http://bugs.mysql.com/bug.php?id=63164). We do not recommend using MySQL due to various issues. For example, case [(in)sensitivity](https://dev.mysql.com/doc/refman/5.0/en/case-sensitivity.html) and [problems](http://bugs.mysql.com/bug.php?id=65830) that [suggested](http://bugs.mysql.com/bug.php?id=50909) [fixes](http://bugs.mysql.com/bug.php?id=65830) [have](http://bugs.mysql.com/bug.php?id=63164).
......
# Installation
# Select Version to Install # Select Version to Install
Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install. In most cases Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install. In most cases
this should be the highest numbered stable branch (example shown below). this should be the highest numbered stable branch (example shown below).
......
# Operating Systems # Requirements
## Operating Systems
GitLab is developed for the Linux operating system. For the installations options and instructions please see [the installation section of the readme](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md#installation). GitLab is developed for the Linux operating system. For the installations options and instructions please see [the installation section of the readme](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md#installation).
......
# Corporate contributor license agreement
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to GitLab B.V.. Except for the license granted herein to GitLab B.V. and recipients of software distributed by GitLab B.V., You reserve all right, title, and interest in and to Your Contributions. You accept and agree to the following terms and conditions for Your present and future Contributions submitted to GitLab B.V.. Except for the license granted herein to GitLab B.V. and recipients of software distributed by GitLab B.V., You reserve all right, title, and interest in and to Your Contributions.
1. Definitions. 1. Definitions.
......
# Individual contributor license agreement
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to GitLab B.V.. Except for the license granted herein to GitLab B.V. and recipients of software distributed by GitLab B.V., You reserve all right, title, and interest in and to Your Contributions. You accept and agree to the following terms and conditions for Your present and future Contributions submitted to GitLab B.V.. Except for the license granted herein to GitLab B.V. and recipients of software distributed by GitLab B.V., You reserve all right, title, and interest in and to Your Contributions.
1. Definitions. 1. Definitions.
......
# Markdown
---------------------------------------------- ----------------------------------------------
Table of Contents Table of Contents
......
# Permissions
Users have different abilities depending on the access level they have in a particular group or project. Users have different abilities depending on the access level they have in a particular group or project.
If a user is both in a project group and in the project itself, the highest permission level is used. If a user is both in a project group and in the project itself, the highest permission level is used.
If a user is a GitLab administrator they receive all permissions. If a user is a GitLab administrator they receive all permissions.
......
# Public access
Gitlab allows you to open selected projects to be accessed **publicly** or **internally**. Gitlab allows you to open selected projects to be accessed **publicly** or **internally**.
Projects with either of these visibility levels will be listen in the [public access directory](/public). Projects with either of these visibility levels will be listen in the [public access directory](/public).
Internal projects will only be available to authenticated users. Internal projects will only be available to authenticated users.
......
# Backup restore
### Create a backup of the GitLab system ### Create a backup of the GitLab system
Creates a backup archive of the database and all repositories. This archive will be saved in backup_path (see `config/gitlab.yml`). Creates a backup archive of the database and all repositories. This archive will be saved in backup_path (see `config/gitlab.yml`).
......
# Cleanup
### Remove garbage from filesystem. Important! Data loss! ### Remove garbage from filesystem. Important! Data loss!
Remove namespaces(dirs) from `/home/git/repositories` if they don't exist in GitLab database. Remove namespaces(dirs) from `/home/git/repositories` if they don't exist in GitLab database.
......
# Import
### Import bare repositories into GitLab project instance ### Import bare repositories into GitLab project instance
Notes: Notes:
......
# Maintenance
### Gather information about GitLab and the system it runs on ### Gather information about GitLab and the system it runs on
This command gathers information about your GitLab installation and the System This command gathers information about your GitLab installation and the System
......
# User management
### Add user as a developer to all projects ### Add user as a developer to all projects
```bash ```bash
......
# Web hooks
### Add a web hook for **ALL** projects: ### Add a web hook for **ALL** projects:
RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook"
......
# Monthly Release # Monthly Release
NOTE: This is a guide for GitLab developers. NOTE: This is a guide for GitLab developers.
# **15th - Code Freeze & Release Manager** # **15th - Code Freeze & Release Manager**
......
# Things to do when doing a patch release # Things to do when doing a patch release
NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update). NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update).
## When to do a patch release ## When to do a patch release
......
# Things to do when doing an out-of-bound security release # Things to do when doing an out-of-bound security release
NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update). NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update).
## When to do a security release ## When to do a security release
......
# Rack attack
To prevent abusive clients doing damage GitLab uses rack-attack gem. To prevent abusive clients doing damage GitLab uses rack-attack gem.
If you installed or upgraded GitLab by following the official guides this should be enabled by default. If you installed or upgraded GitLab by following the official guides this should be enabled by default.
If you are missing `config/initializers/rack_attack.rb` the following steps need to be taken in order to enable protection for your GitLab instance: If you are missing `config/initializers/rack_attack.rb` the following steps need to be taken in order to enable protection for your GitLab instance:
......
# Deploy keys
Deploy keys allow read-only access one or multiple projects with a single SSH key. Deploy keys allow read-only access one or multiple projects with a single SSH key.
This is really useful for cloning repositories to your Continuous Integration (CI) server. This is really useful for cloning repositories to your Continuous Integration (CI) server.
......
# SSH keys
SSH key allows you to establish a secure connection between your computer and GitLab SSH key allows you to establish a secure connection between your computer and GitLab
......
# System hooks
Your GitLab instance can perform HTTP POST requests on the following events: `create_project`, `delete_project`, `create_user`, `delete_user` and `change_team_member`. Your GitLab instance can perform HTTP POST requests on the following events: `create_project`, `delete_project`, `create_user`, `delete_user` and `change_team_member`.
System hooks can be used, e.g. for logging or changing information in a LDAP server. System hooks can be used, e.g. for logging or changing information in a LDAP server.
......
# Web hooks
Project web hooks allow you to trigger an URL if new code is pushed or a new issue is created. Project web hooks allow you to trigger an URL if new code is pushed or a new issue is created.
--- ---
......
# Authorization for Merge requests
There are two main ways to have a merge request flow with GitLab: working with protected branches in a single repository, or working with forks of an authoritative project. There are two main ways to have a merge request flow with GitLab: working with protected branches in a single repository, or working with forks of an authoritative project.
## Protected branch flow ## Protected branch flow
......
# Project features
When in a Project -> Settings, you will find Features on the bottom of the page that you can toggle. When in a Project -> Settings, you will find Features on the bottom of the page that you can toggle.
Below you will find a more elaborate explanation of each of these. Below you will find a more elaborate explanation of each of these.
......
# Workflow
1. Clone project 1. Clone project
```bash ```bash
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment