Commit a23d0ef98ed1ca2e6d5141dfbfaabf707f152f62
Exists in
spb-stable
and in
3 other branches
Merge branch 'readable-doc-readme' into 'master'
Readable-doc-readme This prepares the doc readme for inclusion on the help page and gives it sections so you can quickly find the relevant part.
Showing
1 changed file
with
23 additions
and
17 deletions
Show diff stats
doc/README.md
| 1 | -## The GitLab Documentation covers the following subjects | |
| 1 | +**User documentation** | |
| 2 | 2 | |
| 3 | -+ [API](api/README.md) | |
| 4 | -+ [Development](development/README.md) | |
| 5 | -+ [Install](install/README.md) | |
| 6 | -+ [Integration](integration/external-issue-tracker.md) | |
| 7 | -+ [Legal](legal/README.md) | |
| 8 | -+ [Markdown](markdown/markdown.md) | |
| 9 | -+ [Permissions](permissions/permissions.md) | |
| 10 | -+ [Public access](public_access/public_access.md) | |
| 11 | -+ [Raketasks](raketasks/README.md) | |
| 12 | -+ [Release](release/README.md) | |
| 13 | -+ [Security](security/README.md) | |
| 14 | -+ [SSH](ssh/README.md) | |
| 15 | -+ [System hooks](system_hooks/system_hooks.md) | |
| 16 | -+ [Update](update/README.md) | |
| 17 | -+ [Web hooks](web_hooks/web_hooks.md) | |
| 18 | -+ [Workflow](workflow/README.md) | |
| 3 | ++ [API](api/README.md) Explore how you can access GitLab via a simple and powerful API. | |
| 4 | ++ [Markdown](markdown/markdown.md) Learn what you can do with GitLab's advanced formatting system. | |
| 5 | ++ [Permissions](permissions/permissions.md) Learn what each role in a project (guest/reporter/developer/master/owner) can do. | |
| 6 | ++ [Public access](public_access/public_access.md) Learn how you can allow public and internal access to a project. | |
| 7 | ++ [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects. | |
| 8 | ++ [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project. | |
| 9 | ++ [Workflow](workflow/workflow.md) Learn how to use Git and GitLab together. | |
| 10 | + | |
| 11 | +**Administrator documentation** | |
| 12 | + | |
| 13 | ++ [Install](install/README.md) Requirements, directory structures and manual installation. | |
| 14 | ++ [Integration](integration/external-issue-tracker.md) How to integrate JIRA and Redmine. | |
| 15 | ++ [Raketasks](raketasks/README.md) Explore what GitLab has in store for you to make administration easier. | |
| 16 | ++ [System hooks](system_hooks/system_hooks.md) Let GitLab notify you when certain management tasks need to be carried out. | |
| 17 | ++ [Security](security/README.md) Learn what you can do to further secure your GitLab instance. | |
| 18 | ++ [Update](update/README.md) Update guides to upgrade your installation. | |
| 19 | + | |
| 20 | +**Contributor documentation** | |
| 21 | + | |
| 22 | ++ [Development](development/README.md) Explains the architecture and the guidelines for shell commands. | |
| 23 | ++ [Legal](legal/README.md) Contributor license agreements. | |
| 24 | ++ [Release](release/README.md) How to make the monthly and security releases. | ... | ... |