From b04c343311dfd5f12815936384762a9f1412fe34 Mon Sep 17 00:00:00 2001 From: dosire Date: Thu, 27 Mar 2014 10:53:26 +0100 Subject: Put important information at the top of the readme. --- doc/api/README.md | 53 ++++++++++++++++++++++++++--------------------------- 1 file changed, 26 insertions(+), 27 deletions(-) diff --git a/doc/api/README.md b/doc/api/README.md index 850666953a3..fa5b12af14c 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,5 +1,31 @@ # GitLab API +## End-points + ++ [Users](users.md) ++ [Session](session.md) ++ [Projects](projects.md) ++ [Project Snippets](project_snippets.md) ++ [Repositories](repositories.md) ++ [Repository Files](repository_files.md) ++ [Commits](commits.md) ++ [Merge Requests](merge_requests.md) ++ [Issues](issues.md) ++ [Milestones](milestones.md) ++ [Notes](notes.md) ++ [Deploy Keys](deploy_keys.md) ++ [System Hooks](system_hooks.md) ++ [Groups](groups.md) + +## Clients + ++ [php-gitlab-api](https://github.com/m4tthumphrey/php-gitlab-api) - PHP ++ [Ruby Wrapper](https://github.com/NARKOZ/gitlab) - Ruby ++ [python-gitlab](https://github.com/Itxaka/python-gitlab) - Python ++ [java-gitlab-api](https://github.com/timols/java-gitlab-api) - Java + +## Introduction + All API requests require authentication. You need to pass a `private_token` parameter by url or header. If passed as header, the header name must be "PRIVATE-TOKEN" (capital and with dash instead of underscore). You can find or reset your private token in your profile. If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401: @@ -117,30 +143,3 @@ Issue So if you want to get issue with api you use `http://host/api/v3/.../issues/:id.json` But when you want to create a link to web page - use `http:://host/project/issues/:iid.json` - - - -## Contents - -+ [Users](users.md) -+ [Session](session.md) -+ [Projects](projects.md) -+ [Project Snippets](project_snippets.md) -+ [Repositories](repositories.md) -+ [Repository Files](repository_files.md) -+ [Commits](commits.md) -+ [Merge Requests](merge_requests.md) -+ [Issues](issues.md) -+ [Milestones](milestones.md) -+ [Notes](notes.md) -+ [Deploy Keys](deploy_keys.md) -+ [System Hooks](system_hooks.md) -+ [Groups](groups.md) - - -## Clients - -+ [php-gitlab-api](https://github.com/m4tthumphrey/php-gitlab-api) - PHP -+ [Ruby Wrapper](https://github.com/NARKOZ/gitlab) - Ruby -+ [python-gitlab](https://github.com/Itxaka/python-gitlab) - Python -+ [java-gitlab-api](https://github.com/timols/java-gitlab-api) - Java -- cgit v1.2.1 From 8a90db9e33b2dbb46655c0c3044da382b66c4d36 Mon Sep 17 00:00:00 2001 From: dosire Date: Thu, 27 Mar 2014 10:56:30 +0100 Subject: Test the new doc index. --- doc/README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000000..39880b55fa2 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,7 @@ +## The GitLab Documentation covers the following subjects + ++ [API](api/README.md) ++ [API](api/) ++ [API](api) ++ [API](/api/) ++ [API](/api) -- cgit v1.2.1 From 417c0cb2d33e76e271c89e99b323f2443e942107 Mon Sep 17 00:00:00 2001 From: dosire Date: Thu, 27 Mar 2014 12:17:27 +0100 Subject: New doc site needs indexes. --- doc/README.md | 18 ++++++++++++++---- doc/development/README.md | 2 ++ doc/install/README.md | 4 ++++ doc/legal/README.md | 2 ++ doc/raketasks/README.md | 6 ++++++ doc/release/README.md | 2 ++ doc/security/README.md | 2 ++ doc/update/README.md | 5 +++++ 8 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 doc/development/README.md create mode 100644 doc/install/README.md create mode 100644 doc/legal/README.md create mode 100644 doc/raketasks/README.md create mode 100644 doc/release/README.md create mode 100644 doc/security/README.md create mode 100644 doc/update/README.md diff --git a/doc/README.md b/doc/README.md index 39880b55fa2..865806f297a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,7 +1,17 @@ ## The GitLab Documentation covers the following subjects + [API](api/README.md) -+ [API](api/) -+ [API](api) -+ [API](/api/) -+ [API](/api) ++ [Development](development/README.md) ++ [Install](install/README.md) ++ [Integration](external-issue-tracker/README.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) ++ [System hooks](system_hooks/system_hooks.md) ++ [Update](update/README.md) ++ [Web hooks](web_hooks/web_hooks.md) ++ [Workflow](workflow/workflow.md) diff --git a/doc/development/README.md b/doc/development/README.md new file mode 100644 index 00000000000..aa59eb2c3e1 --- /dev/null +++ b/doc/development/README.md @@ -0,0 +1,2 @@ ++ [Architecture](architecture.md) ++ [Shell commands](shell_commands.md) diff --git a/doc/install/README.md b/doc/install/README.md new file mode 100644 index 00000000000..ec80e3cd62a --- /dev/null +++ b/doc/install/README.md @@ -0,0 +1,4 @@ ++ [Installation](installation.md) ++ [Requirements](requirements.md) ++ [Structure](structure.md) ++ [Database MySQL](database_mysql.md) diff --git a/doc/legal/README.md b/doc/legal/README.md new file mode 100644 index 00000000000..ebfdad13540 --- /dev/null +++ b/doc/legal/README.md @@ -0,0 +1,2 @@ ++ [Corporate contributor license agreement](corporate_contributor_license_agreement.md) ++ [Individual contributor license agreement](individual_contributor_license_agreement.md) diff --git a/doc/raketasks/README.md b/doc/raketasks/README.md new file mode 100644 index 00000000000..9aa80af12cc --- /dev/null +++ b/doc/raketasks/README.md @@ -0,0 +1,6 @@ ++ [Backup restore](backup_restore.md) ++ [Cleanup](cleanup.md) ++ [Features](features.md) ++ [Maintenance](maintenance.md) ++ [User management](user_management.md) ++ [Web hooks](web_hooks.md) diff --git a/doc/release/README.md b/doc/release/README.md new file mode 100644 index 00000000000..22510be3f18 --- /dev/null +++ b/doc/release/README.md @@ -0,0 +1,2 @@ ++ [Monthly](monthly.md) ++ [Security](security.md) diff --git a/doc/security/README.md b/doc/security/README.md new file mode 100644 index 00000000000..f8dd1291b9b --- /dev/null +++ b/doc/security/README.md @@ -0,0 +1,2 @@ ++ [Password length limits](password_length_limits.md) ++ [Rack attack](rack_attack.md) diff --git a/doc/update/README.md b/doc/update/README.md new file mode 100644 index 00000000000..97afd71bbe3 --- /dev/null +++ b/doc/update/README.md @@ -0,0 +1,5 @@ ++ [The indivual upgrade guides](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/update) ++ [Uprader](upgrader.md) ++ [Ruby](ruby.md) ++ [Patch versions](patch_versions.md) ++ [MySQL to Postgress](mysql_to_postgress.md) -- cgit v1.2.1