summaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
authorCiro Santilli <ciro.santilli@gmail.com>2014-04-25 00:48:22 +0200
committerCiro Santilli <ciro.santilli@gmail.com>2014-06-03 23:16:31 +0200
commitfd348de76d651d49acc8eb742cc647dc777ef5fc (patch)
tree26f42bef57c9a636eff0a548a29cb1e2e6d12c8c /doc/README.md
parentde1a7aa7eb523cf2fdad12f8eeda2ba4c5b51820 (diff)
downloadgitlab-ce-fd348de76d651d49acc8eb742cc647dc777ef5fc.tar.gz
Update docs to markdown style guide.
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md40
1 files changed, 21 insertions, 19 deletions
diff --git a/doc/README.md b/doc/README.md
index b73d7bb38e1..f05078ee388 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,24 +1,26 @@
-**User documentation**
+# Documentation
-+ [API](api/README.md) Explore how you can access GitLab via a simple and powerful API.
-+ [Markdown](markdown/markdown.md) Learn what you can do with GitLab's advanced formatting system.
-+ [Permissions](permissions/permissions.md) Learn what each role in a project (guest/reporter/developer/master/owner) can do.
-+ [Public access](public_access/public_access.md) Learn how you can allow public and internal access to a project.
-+ [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
-+ [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
-+ [Workflow](workflow/README.md) Learn how to use Git and GitLab together.
+## User documentation
-**Administrator documentation**
+- [API](api/README.md) Explore how you can access GitLab via a simple and powerful API.
+- [Markdown](markdown/markdown.md) Learn what you can do with GitLab's advanced formatting system.
+- [Permissions](permissions/permissions.md) Learn what each role in a project (guest/reporter/developer/master/owner) can do.
+- [Public access](public_access/public_access.md) Learn how you can allow public and internal access to a project.
+- [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
+- [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
+- [Workflow](workflow/README.md) Learn how to use Git and GitLab together.
-+ [Install](install/README.md) Requirements, directory structures and manual installation.
-+ [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
-+ [Raketasks](raketasks/README.md) Explore what GitLab has in store for you to make administration easier.
-+ [System hooks](system_hooks/system_hooks.md) Let GitLab notify you when certain management tasks need to be carried out.
-+ [Security](security/README.md) Learn what you can do to further secure your GitLab instance.
-+ [Update](update/README.md) Update guides to upgrade your installation.
+## Administrator documentation
-**Contributor documentation**
+- [Install](install/README.md) Requirements, directory structures and manual installation.
+- [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
+- [Raketasks](raketasks/README.md) Explore what GitLab has in store for you to make administration easier.
+- [System hooks](system_hooks/system_hooks.md) Let GitLab notify you when certain management tasks need to be carried out.
+- [Security](security/README.md) Learn what you can do to further secure your GitLab instance.
+- [Update](update/README.md) Update guides to upgrade your installation.
-+ [Development](development/README.md) Explains the architecture and the guidelines for shell commands.
-+ [Legal](legal/README.md) Contributor license agreements.
-+ [Release](release/README.md) How to make the monthly and security releases.
+## Contributor documentation
+
+- [Development](development/README.md) Explains the architecture and the guidelines for shell commands.
+- [Legal](legal/README.md) Contributor license agreements.
+- [Release](release/README.md) How to make the monthly and security releases.