Add titles to doc pages.

This commit is contained in:
Marin Jankovski 2014-05-27 14:12:15 +02:00
parent 3bdf0e2921
commit f22c709539
38 changed files with 74 additions and 5 deletions

View file

@ -1,4 +1,4 @@
## Deploy Keys
# Deploy Keys
### List deploy keys

View file

@ -1,3 +1,5 @@
# Groups
## List project groups
Get a list of groups. (As user: my groups, as admin: all groups)

View file

@ -1,3 +1,5 @@
# Issues
## List issues
Get all issues created by authenticated user. This function takes pagination parameters

View file

@ -1,3 +1,5 @@
# Merge requests
## List merge requests
Get all merge requests for this project.

View file

@ -1,3 +1,5 @@
# Milestones
## List project milestones
Returns a list of project milestones.

View file

@ -1,3 +1,5 @@
# Notes
Notes can be wall notes or comments on snippets, issues or merge requests.
## Wall

View file

@ -1,3 +1,5 @@
# Project snippets
## List snippets
Get a list of project snippets.

View file

@ -1,4 +1,4 @@
## Projects
# Projects
### List projects

View file

@ -1,3 +1,5 @@
# Repositories
## List project repository tags
Get a list of repository tags from a project, sorted by name in reverse alphabetical order.

View file

@ -1,4 +1,6 @@
# CRUD for repository files
# Repository files
## CRUD for repository files
## Create, read, update and delete repository files using this API

View file

@ -1,3 +1,5 @@
# Session
Login to get private token
```

View file

@ -1,3 +1,5 @@
# System hooks
All methods require admin authorization.
The url endpoint of the system hooks can be configured in [the admin area under hooks](/admin/hooks).

View file

@ -1,3 +1,5 @@
# Users
## List users
Get a list of users.

View file

@ -1,3 +1,5 @@
# Database Mysql
## 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).

View file

@ -1,3 +1,5 @@
# Installation
# 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
this should be the highest numbered stable branch (example shown below).

View file

@ -1,4 +1,6 @@
# 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).

View file

@ -1,3 +1,5 @@
# 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.
1. Definitions.

View file

@ -1,3 +1,5 @@
# 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.
1. Definitions.

View file

@ -1,3 +1,5 @@
# Markdown
----------------------------------------------
Table of Contents

View file

@ -1,3 +1,5 @@
# Permissions
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 a GitLab administrator they receive all permissions.

View file

@ -1,3 +1,5 @@
# Public access
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).
Internal projects will only be available to authenticated users.

View file

@ -1,3 +1,5 @@
# Backup restore
### 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`).

View file

@ -1,3 +1,5 @@
# Cleanup
### Remove garbage from filesystem. Important! Data loss!
Remove namespaces(dirs) from `/home/git/repositories` if they don't exist in GitLab database.

View file

@ -1,3 +1,5 @@
# Import
### Import bare repositories into GitLab project instance
Notes:

View file

@ -1,3 +1,5 @@
# Maintenance
### Gather information about GitLab and the system it runs on
This command gathers information about your GitLab installation and the System

View file

@ -1,3 +1,5 @@
# User management
### Add user as a developer to all projects
```bash

View file

@ -1,3 +1,5 @@
# Web hooks
### Add a web hook for **ALL** projects:
RAILS_ENV=production bundle exec rake gitlab:web_hook:add URL="http://example.com/hook"

View file

@ -1,4 +1,5 @@
# Monthly Release
NOTE: This is a guide for GitLab developers.
# **15th - Code Freeze & Release Manager**

View file

@ -1,4 +1,5 @@
# 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).
## When to do a patch release

View file

@ -1,4 +1,5 @@
# 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).
## When to do a security release

View file

@ -1,3 +1,5 @@
# Rack attack
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 are missing `config/initializers/rack_attack.rb` the following steps need to be taken in order to enable protection for your GitLab instance:

View file

@ -1,3 +1,5 @@
# Deploy keys
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.

View file

@ -1,3 +1,5 @@
# SSH keys
SSH key allows you to establish a secure connection between your computer and GitLab

View file

@ -1,3 +1,5 @@
# 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`.
System hooks can be used, e.g. for logging or changing information in a LDAP server.

View file

@ -1,3 +1,5 @@
# Web hooks
Project web hooks allow you to trigger an URL if new code is pushed or a new issue is created.
---

View file

@ -1,3 +1,5 @@
# 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.
## Protected branch flow

View file

@ -1,3 +1,5 @@
# Project features
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.

View file

@ -1,3 +1,5 @@
# Workflow
1. Clone project
```bash