From f22c709539d06be6fa76f148dedffdef1170936c Mon Sep 17 00:00:00 2001
From: Marin Jankovski <marin@gitlab.com>
Date: Tue, 27 May 2014 14:12:15 +0200
Subject: [PATCH] Add titles to doc pages.
---
doc/api/deploy_keys.md | 2 +-
doc/api/groups.md | 2 ++
doc/api/issues.md | 2 ++
doc/api/merge_requests.md | 2 ++
doc/api/milestones.md | 2 ++
doc/api/notes.md | 2 ++
doc/api/project_snippets.md | 2 ++
doc/api/projects.md | 2 +-
doc/api/repositories.md | 2 ++
doc/api/repository_files.md | 4 +++-
doc/api/session.md | 2 ++
doc/api/system_hooks.md | 2 ++
doc/api/users.md | 2 ++
doc/install/database_mysql.md | 2 ++
doc/install/installation.md | 2 ++
doc/install/requirements.md | 4 +++-
doc/legal/corporate_contributor_license_agreement.md | 2 ++
doc/legal/individual_contributor_license_agreement.md | 2 ++
doc/markdown/markdown.md | 2 ++
doc/permissions/permissions.md | 2 ++
doc/public_access/public_access.md | 2 ++
doc/raketasks/backup_restore.md | 2 ++
doc/raketasks/cleanup.md | 2 ++
doc/raketasks/import.md | 2 ++
doc/raketasks/maintenance.md | 2 ++
doc/raketasks/user_management.md | 2 ++
doc/raketasks/web_hooks.md | 2 ++
doc/release/monthly.md | 1 +
doc/release/patch.md | 1 +
doc/release/security.md | 1 +
doc/security/rack_attack.md | 4 +++-
doc/ssh/deploy_keys.md | 2 ++
doc/ssh/ssh.md | 2 ++
doc/system_hooks/system_hooks.md | 2 ++
doc/web_hooks/web_hooks.md | 2 ++
doc/workflow/authorization_for_merge_requests.md | 2 ++
doc/workflow/project_features.md | 2 ++
doc/workflow/workflow.md | 2 ++
38 files changed, 74 insertions(+), 5 deletions(-)
diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md
index d6c0e624dfb00..6aa7be93c01d6 100644
--- a/doc/api/deploy_keys.md
+++ b/doc/api/deploy_keys.md
@@ -1,4 +1,4 @@
-## Deploy Keys
+# Deploy Keys
### List deploy keys
diff --git a/doc/api/groups.md b/doc/api/groups.md
index f5f5d7690509c..1dbb93f9082d3 100644
--- 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)
diff --git a/doc/api/issues.md b/doc/api/issues.md
index d18506f9ce6a6..c769d7bb69abd 100644
--- 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
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index d68f34971f1be..284c2befe6fff 100644
--- 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.
diff --git a/doc/api/milestones.md b/doc/api/milestones.md
index 2a2ef4b79b1d2..b0f355b9a0c88 100644
--- a/doc/api/milestones.md
+++ b/doc/api/milestones.md
@@ -1,3 +1,5 @@
+# Milestones
+
## List project milestones
Returns a list of project milestones.
diff --git a/doc/api/notes.md b/doc/api/notes.md
index e9ad6e00c7316..6d140643fcbc6 100644
--- 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
diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md
index e16e1e845963e..7a49827233422 100644
--- 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.
diff --git a/doc/api/projects.md b/doc/api/projects.md
index ffaba0af7fe40..ae2b8365e80fc 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -1,4 +1,4 @@
-## Projects
+# Projects
### List projects
diff --git a/doc/api/repositories.md b/doc/api/repositories.md
index e9120e17bb82d..ecb0fa3f6a0d1 100644
--- 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.
diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md
index b215cc2500197..820ae71361dfa 100644
--- 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
diff --git a/doc/api/session.md b/doc/api/session.md
index 0be5af79dad92..2e717a2ea7799 100644
--- a/doc/api/session.md
+++ b/doc/api/session.md
@@ -1,3 +1,5 @@
+# Session
+
Login to get private token
```
diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md
index d4c45ea9bbd9f..0d33aee21339f 100644
--- 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).
diff --git a/doc/api/users.md b/doc/api/users.md
index 2b927c3077734..c185cf6478a3e 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -1,3 +1,5 @@
+# Users
+
## List users
Get a list of users.
diff --git a/doc/install/database_mysql.md b/doc/install/database_mysql.md
index bf8183729e7fb..270ad3b0b86b2 100644
--- 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).
diff --git a/doc/install/installation.md b/doc/install/installation.md
index 44f5a28fde5e1..73fef0dadfeba 100644
--- 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).
diff --git a/doc/install/requirements.md b/doc/install/requirements.md
index fd2dd16cd8eb4..2830a75df52bb 100644
--- 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).
diff --git a/doc/legal/corporate_contributor_license_agreement.md b/doc/legal/corporate_contributor_license_agreement.md
index fb8d52e6bd41f..eb808d8a761fd 100644
--- 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.
diff --git a/doc/legal/individual_contributor_license_agreement.md b/doc/legal/individual_contributor_license_agreement.md
index 7ac9d6e4cde78..95cbed7e75bb7 100644
--- 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.
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md
index e7ebc613431c6..47cb04cdb0484 100644
--- a/doc/markdown/markdown.md
+++ b/doc/markdown/markdown.md
@@ -1,3 +1,5 @@
+# Markdown
+
----------------------------------------------
Table of Contents
diff --git a/doc/permissions/permissions.md b/doc/permissions/permissions.md
index 9a3dcefe5698f..840bb90163b1e 100644
--- 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.
diff --git a/doc/public_access/public_access.md b/doc/public_access/public_access.md
index bb23a4bfd96fa..1714a7eeae48b 100644
--- 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.
diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md
index bdff6ad5da8f0..f0be2b6a44187 100644
--- 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`).
diff --git a/doc/raketasks/cleanup.md b/doc/raketasks/cleanup.md
index 99809ef434df7..b0b82754da688 100644
--- 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.
diff --git a/doc/raketasks/import.md b/doc/raketasks/import.md
index e11328dc5ce7d..628bd373b8d7c 100644
--- a/doc/raketasks/import.md
+++ b/doc/raketasks/import.md
@@ -1,3 +1,5 @@
+# Import
+
### Import bare repositories into GitLab project instance
Notes:
diff --git a/doc/raketasks/maintenance.md b/doc/raketasks/maintenance.md
index 907c9352c5976..da58962499b71 100644
--- 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
diff --git a/doc/raketasks/user_management.md b/doc/raketasks/user_management.md
index e82320829166a..d5b173fde65b1 100644
--- 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
diff --git a/doc/raketasks/web_hooks.md b/doc/raketasks/web_hooks.md
index 1ca5bacb9d104..4ffbf5f8698a6 100644
--- 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"
diff --git a/doc/release/monthly.md b/doc/release/monthly.md
index 5e85fe0825ef7..71cd56a099983 100644
--- 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**
diff --git a/doc/release/patch.md b/doc/release/patch.md
index 30bb39b4e49d6..6d8866a0cfbe7 100644
--- 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
diff --git a/doc/release/security.md b/doc/release/security.md
index 2fe0a948ad2fe..ac2f79dfb9284 100644
--- 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
diff --git a/doc/security/rack_attack.md b/doc/security/rack_attack.md
index a0d02b1650f3e..9e863bbd19018 100644
--- 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).
\ No newline at end of file
+For more information on how to use these options check out [rack-attack README](https://github.com/kickstarter/rack-attack/blob/master/README.md).
diff --git a/doc/ssh/deploy_keys.md b/doc/ssh/deploy_keys.md
index c7125b7949e7b..e113160c9bc1e 100644
--- 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.
diff --git a/doc/ssh/ssh.md b/doc/ssh/ssh.md
index 0a38bc16b49ce..f89b6a14ce1c4 100644
--- 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
diff --git a/doc/system_hooks/system_hooks.md b/doc/system_hooks/system_hooks.md
index 5c8daf466ab43..5a1a32c1edbd0 100644
--- 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.
diff --git a/doc/web_hooks/web_hooks.md b/doc/web_hooks/web_hooks.md
index 4c06bc4d44401..19a60db00ad34 100644
--- 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.
---
diff --git a/doc/workflow/authorization_for_merge_requests.md b/doc/workflow/authorization_for_merge_requests.md
index 4e07d7c04c5dc..cc7031b11e143 100644
--- 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
diff --git a/doc/workflow/project_features.md b/doc/workflow/project_features.md
index 64f4ddaa1255a..ec2c273db01ee 100644
--- 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.
diff --git a/doc/workflow/workflow.md b/doc/workflow/workflow.md
index bb232e9d5c57d..8186cd53b200f 100644
--- a/doc/workflow/workflow.md
+++ b/doc/workflow/workflow.md
@@ -1,3 +1,5 @@
+# Workflow
+
1. Clone project
```bash
--
GitLab