Add titles to doc pages.

2014-05-27 14:12:15 +02:00 · 2014-05-27 14:12:15 +02:00 · f22c709539
parent 3bdf0e2921
commit f22c709539
38 changed files with 74 additions and 5 deletions
--- a/doc/api/deploy_keys.md
+++ b/doc/api/deploy_keys.md
@ -1,4 +1,4 @@
-## Deploy Keys
+# Deploy Keys

 ### List deploy keys

--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@ -1,3 +1,5 @@
+# Groups
+
 ## List project groups

 Get a list of groups. (As user: my groups, as admin: all groups)
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@ -1,3 +1,5 @@
+# Issues
+
 ## List issues

 Get all issues created by authenticated user. This function takes pagination parameters
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@ -1,3 +1,5 @@
+# Merge requests
+
 ## List merge requests

 Get all merge requests for this project.
--- a/doc/api/milestones.md
+++ b/doc/api/milestones.md
@ -1,3 +1,5 @@
+# Milestones
+
 ## List project milestones

 Returns a list of project milestones.
--- a/doc/api/notes.md
+++ b/doc/api/notes.md
@ -1,3 +1,5 @@
+# Notes
+
 Notes can be wall notes or comments on snippets, issues or merge requests.

 ## Wall
--- a/doc/api/project_snippets.md
+++ b/doc/api/project_snippets.md
@ -1,3 +1,5 @@
+# Project snippets
+
 ## List snippets

 Get a list of project snippets.
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@ -1,4 +1,4 @@
-## Projects
+# Projects

 ### List projects

--- a/doc/api/repositories.md
+++ b/doc/api/repositories.md
@ -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.
--- a/doc/api/repository_files.md
+++ b/doc/api/repository_files.md
@ -1,4 +1,6 @@
-# CRUD for repository files
+# Repository files
+
+## CRUD for repository files

 ## Create, read, update and delete repository files using this API

--- a/doc/api/session.md
+++ b/doc/api/session.md
@ -1,3 +1,5 @@
+# Session
+
 Login to get private token

 ```
--- a/doc/api/system_hooks.md
+++ b/doc/api/system_hooks.md
@ -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).
--- a/doc/api/users.md
+++ b/doc/api/users.md
@ -1,3 +1,5 @@
+# Users
+
 ## List users

 Get a list of users.
--- a/doc/install/database_mysql.md
+++ b/doc/install/database_mysql.md
@ -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).
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@ -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).
--- a/doc/install/requirements.md
+++ b/doc/install/requirements.md
@ -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).

--- a/doc/legal/corporate_contributor_license_agreement.md
+++ b/doc/legal/corporate_contributor_license_agreement.md
@ -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.
--- a/doc/legal/individual_contributor_license_agreement.md
+++ b/doc/legal/individual_contributor_license_agreement.md
@ -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.
--- a/doc/markdown/markdown.md
+++ b/doc/markdown/markdown.md
@ -1,3 +1,5 @@
+# Markdown
+
 ----------------------------------------------

 Table of Contents
--- a/doc/permissions/permissions.md
+++ b/doc/permissions/permissions.md
@ -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.
--- a/doc/public_access/public_access.md
+++ b/doc/public_access/public_access.md
@ -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.
--- a/doc/raketasks/backup_restore.md
+++ b/doc/raketasks/backup_restore.md
@ -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`).
--- a/doc/raketasks/cleanup.md
+++ b/doc/raketasks/cleanup.md
@ -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.
--- a/doc/raketasks/import.md
+++ b/doc/raketasks/import.md
@ -1,3 +1,5 @@
+# Import
+
 ### Import bare repositories into GitLab project instance

 Notes:
--- a/doc/raketasks/maintenance.md
+++ b/doc/raketasks/maintenance.md
@ -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
--- a/doc/raketasks/user_management.md
+++ b/doc/raketasks/user_management.md
@ -1,3 +1,5 @@
+# User management
+
 ### Add user as a developer to all projects

 ```bash
--- a/doc/raketasks/web_hooks.md
+++ b/doc/raketasks/web_hooks.md
@ -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"
--- a/doc/release/monthly.md
+++ b/doc/release/monthly.md
@ -1,4 +1,5 @@
 # Monthly Release
+
 NOTE: This is a guide for GitLab developers.

 # **15th - Code Freeze & Release Manager**
--- a/doc/release/patch.md
+++ b/doc/release/patch.md
@ -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
--- a/doc/release/security.md
+++ b/doc/release/security.md
@ -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
--- a/doc/security/rack_attack.md
+++ b/doc/security/rack_attack.md
@ -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:
@ -16,4 +18,4 @@ If you want more restrictive/relaxed throttle rule change the `limit` or `period

 In case you find throttling is not enough to protect you against abusive clients, rack-attack gem offers IP whitelisting, blacklisting, Fail2ban style filter and tracking.

-For more information on how to use these options check out [rack-attack README](https://github.com/kickstarter/rack-attack/blob/master/README.md).
+For more information on how to use these options check out [rack-attack README](https://github.com/kickstarter/rack-attack/blob/master/README.md).
--- a/doc/ssh/deploy_keys.md
+++ b/doc/ssh/deploy_keys.md
@ -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.
--- a/doc/ssh/ssh.md
+++ b/doc/ssh/ssh.md
@ -1,3 +1,5 @@
+# SSH keys
+
 SSH key allows you to establish a secure connection between your computer and GitLab


--- a/doc/system_hooks/system_hooks.md
+++ b/doc/system_hooks/system_hooks.md
@ -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.
--- a/doc/web_hooks/web_hooks.md
+++ b/doc/web_hooks/web_hooks.md
@ -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.

 ---
--- a/doc/workflow/authorization_for_merge_requests.md
+++ b/doc/workflow/authorization_for_merge_requests.md
@ -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
--- a/doc/workflow/project_features.md
+++ b/doc/workflow/project_features.md
@ -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.

--- a/doc/workflow/workflow.md
+++ b/doc/workflow/workflow.md
@ -1,3 +1,5 @@
+# Workflow
+
 1. Clone project

  ```bash