From cc3ea3d3736db8d089e6e94d8f863d47631d0963 Mon Sep 17 00:00:00 2001 From: dosire Date: Wed, 2 Apr 2014 12:46:17 +0200 Subject: [PATCH 1/3] Adapt the layout of the doc readme to fit the help page. --- doc/README.md | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/doc/README.md b/doc/README.md index d85a2d854d..9d39a1b0cd 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,18 +1,26 @@ ## The GitLab Documentation covers the following subjects -+ [API](api/README.md) -+ [Development](development/README.md) -+ [Install](install/README.md) -+ [Integration](integration/external-issue-tracker.md) -+ [Legal](legal/README.md) -+ [Markdown](markdown/markdown.md) -+ [Permissions](permissions/permissions.md) -+ [Public access](public_access/public_access.md) -+ [Raketasks](raketasks/README.md) -+ [Release](release/README.md) -+ [Security](security/README.md) -+ [SSH](ssh/README.md) -+ [System hooks](system_hooks/system_hooks.md) -+ [Update](update/README.md) -+ [Web hooks](web_hooks/web_hooks.md) -+ [Workflow](workflow/workflow.md) +User 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/workflow.md) Learn how to use Git and GitLab together. + +Administrator documentation + ++ [Install](install/README.md) Requirements, directory structures and manual installation. ++ [Integration](integration/external-issue-tracker.md) How to integrate JIRA and Redmine. ++ [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. + +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. From 7aacc08a92c2bbac74c45d9b506a801f3d947984 Mon Sep 17 00:00:00 2001 From: dosire Date: Wed, 2 Apr 2014 12:47:07 +0200 Subject: [PATCH 2/3] Make headers of the doc bold. --- doc/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index 9d39a1b0cd..3c76f9e4f8 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,6 +1,6 @@ ## The GitLab Documentation covers the following subjects -User documentation +**User 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. @@ -10,7 +10,7 @@ User documentation + [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project. + [Workflow](workflow/workflow.md) Learn how to use Git and GitLab together. -Administrator documentation +**Administrator documentation** + [Install](install/README.md) Requirements, directory structures and manual installation. + [Integration](integration/external-issue-tracker.md) How to integrate JIRA and Redmine. @@ -19,7 +19,7 @@ Administrator documentation + [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. -Contributor documentation +**Contributor documentation** + [Development](development/README.md) Explains the architecture and the guidelines for shell commands. + [Legal](legal/README.md) Contributor license agreements. From d54e3f361ad61a9bd767ec2d4ab00277d4a06c6d Mon Sep 17 00:00:00 2001 From: dosire Date: Wed, 2 Apr 2014 12:47:45 +0200 Subject: [PATCH 3/3] Remove top header. --- doc/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 3c76f9e4f8..dfa3211d01 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,5 +1,3 @@ -## The GitLab Documentation covers the following subjects - **User documentation** + [API](api/README.md) Explore how you can access GitLab via a simple and powerful API.