diff options
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | doc/README.md | 1 | ||||
| -rw-r--r-- | doc/api/README.md | 4 | ||||
| -rw-r--r-- | doc/api/users.md | 4 | ||||
| -rw-r--r-- | doc/ssh/README.md | 2 | ||||
| -rw-r--r-- | doc/ssh/deploy_keys.md | 2 | ||||
| -rw-r--r-- | doc/update/README.md | 2 | ||||
| -rw-r--r-- | doc/update/mysql_to_postgresql.md (renamed from doc/update/mysql-to-postgresql.md) | 0 |
8 files changed, 15 insertions, 14 deletions
diff --git a/README.md b/README.md index 2668ed8bac0..fcc40f1b917 100644 --- a/README.md +++ b/README.md @@ -113,19 +113,9 @@ or start each component separately Single Spinach test: bundle exec spinach features/project/issues/milestones.feature -### GitLab interfaces +### Documentation -* [GitLab API doc](doc/api/README.md) or see the [GitLab API website](http://api.gitlab.org/) - -* [Rake tasks](doc/raketasks) including a [backup and restore procedure](doc/raketasks/backup_restore.md) - -* [Directory structure](doc/install/structure.md) - -* [Database installation](doc/install/databases.md) - -* [Markdown specification](doc/markdown/markdown.md) - -* [Security guide](doc/security/rack_attack.md) to throttle abusive requests +All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/). ### Getting help diff --git a/doc/README.md b/doc/README.md index 865806f297a..99a0d678cdf 100644 --- a/doc/README.md +++ b/doc/README.md @@ -11,6 +11,7 @@ + [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) diff --git a/doc/api/README.md b/doc/api/README.md index b2edf47fe5c..a2925674f85 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -130,6 +130,10 @@ When listing resources you can pass the following parameters: + `page` (default: `1`) - page number + `per_page` (default: `20`, max: `100`) - number of items to list per page +[Link headers](http://www.w3.org/wiki/LinkHeader) are send back with each response. +These have `rel` prev/next/first/last and contain the relevant url. +Please use these instead of generating your own urls. + ## id vs iid When you work with API you may notice two similar fields in api entites: id and iid. diff --git a/doc/api/users.md b/doc/api/users.md index 4098da72b30..1b9eecf2159 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -51,6 +51,10 @@ GET /users ] ``` +You can search for a users by email or username with: +`/users?search=John` + +Also see `def search query` in `app/models/user.rb`. ## Single user diff --git a/doc/ssh/README.md b/doc/ssh/README.md new file mode 100644 index 00000000000..76d9e8bb075 --- /dev/null +++ b/doc/ssh/README.md @@ -0,0 +1,2 @@ ++ [Deploy keys](deploy_keys.md) ++ [SSH](ssh.md) diff --git a/doc/ssh/deploy_keys.md b/doc/ssh/deploy_keys.md index 56fe98bb101..c7125b7949e 100644 --- a/doc/ssh/deploy_keys.md +++ b/doc/ssh/deploy_keys.md @@ -9,4 +9,4 @@ After this the machine that uses the corresponding private key has read-only acc You can't add the same deploy key twice with the 'New Deploy Key' option. If you want to add the same key to another project please enable it in the list that says 'Deploy keys from projects available to you'. -You need to be the owner of the deploy key to see it in this list. +All the deploy keys of all the projects you have access to are available. This project access can happen through being a direct member of the project or through a group. See `def accessible_deploy_keys` in `app/models/user.rb` for more information. diff --git a/doc/update/README.md b/doc/update/README.md index 97afd71bbe3..06e3764616f 100644 --- a/doc/update/README.md +++ b/doc/update/README.md @@ -2,4 +2,4 @@ + [Uprader](upgrader.md) + [Ruby](ruby.md) + [Patch versions](patch_versions.md) -+ [MySQL to Postgress](mysql_to_postgress.md) ++ [MySQL to PostgreSQL](mysql_to_postgresql.md) diff --git a/doc/update/mysql-to-postgresql.md b/doc/update/mysql_to_postgresql.md index 9a324545eb0..9a324545eb0 100644 --- a/doc/update/mysql-to-postgresql.md +++ b/doc/update/mysql_to_postgresql.md |