diff options
| -rw-r--r-- | doc/api/projects.md | 32 | ||||
| -rw-r--r-- | doc/development/rake_tasks.md | 6 | ||||
| -rw-r--r-- | doc/markdown/markdown.md | 23 | ||||
| -rw-r--r-- | doc/update/4.2-to-5.0.md | 5 | ||||
| -rw-r--r-- | doc/update/5.1-to-6.0.md | 6 | ||||
| -rw-r--r-- | doc/update/6.9-to-7.0.md | 2 |
6 files changed, 43 insertions, 31 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 54135079e8b..e27f0c0226b 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -86,7 +86,7 @@ GET /projects #### List owned projects -Get a list of projects owned by the authenticated user. +Get a list of projects which are owned by the authenticated user. ``` GET /projects/owned @@ -102,7 +102,7 @@ GET /projects/all ### Get single project -Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME , which is owned by the authentication user. +Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user. If using namespaced projects call make sure that the NAMESPACE/PROJECT_NAME is URL-encoded, eg. `/api/v3/projects/diaspora%2Fdiaspora` (where `/` is represented by `%2F`). ``` @@ -163,7 +163,7 @@ Parameters: ### Get project events -Get a project events for specific project. +Get the events for the specified project. Sorted from newest to latest ``` @@ -237,7 +237,7 @@ Parameters: ### Create project -Creates new project owned by user. +Creates a new project owned by the authenticated user. ``` POST /projects @@ -259,7 +259,7 @@ Parameters: ### Create project for user -Creates a new project owned by user. Available only for admins. +Creates a new project owned by the specified user. Available only for admins. ``` POST /projects/user/:user_id @@ -282,7 +282,7 @@ Parameters: ## Remove project -Removes project with all resources(issues, merge requests etc) +Removes a project including all associated resources (issues, merge requests etc.) ``` DELETE /projects/:id @@ -297,7 +297,7 @@ Parameters: ### List project team members -Get a list of project team members. +Get a list of a project's team members. ``` GET /projects/:id/members @@ -354,7 +354,7 @@ Parameters: ### Edit project team member -Updates project team member to a specified access level. +Updates a project team member to a specified access level. ``` PUT /projects/:id/members/:user_id @@ -369,7 +369,7 @@ Parameters: ### Remove project team member -Removes user from project team. +Removes a user from a project team. ``` DELETE /projects/:id/members/:user_id @@ -390,7 +390,7 @@ rely on the returned JSON structure. ### List project hooks -Get list of project hooks. +Get a list of project hooks. ``` GET /projects/:id/hooks @@ -403,7 +403,7 @@ Parameters: ### Get project hook -Get a specific hook for project. +Get a specific hook for a project. ``` GET /projects/:id/hooks/:hook_id @@ -429,7 +429,7 @@ Parameters: ### Add project hook -Adds a hook to project. +Adds a hook to a specified project. ``` POST /projects/:id/hooks @@ -446,7 +446,7 @@ Parameters: ### Edit project hook -Edits a hook for project. +Edits a hook for a specified project. ``` PUT /projects/:id/hooks/:hook_id @@ -464,7 +464,7 @@ Parameters: ### Delete project hook -Removes a hook from project. This is an idempotent method and can be called multiple times. +Removes a hook from a project. This is an idempotent method and can be called multiple times. Either the hook is available or not. ``` @@ -591,7 +591,7 @@ Parameters: ## Admin fork relation -Allows modification of the forked relationship between existing projects. . Available only for admins. +Allows modification of the forked relationship between existing projects. Available only for admins. ### Create a forked from/to relation between existing projects. @@ -617,7 +617,7 @@ Parameter: ## Search for projects by name -Search for projects by name which are public or the calling user has access to +Search for projects by name which are accessible to the authenticated user. ``` GET /projects/search/:query diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md index 9e75b3a6275..6d9ac161e91 100644 --- a/doc/development/rake_tasks.md +++ b/doc/development/rake_tasks.md @@ -2,7 +2,7 @@ ## Setup db with developer seeds: -Note that if your db user does not have advanced privilegies you must create db manually before run this command +Note that if your db user does not have advanced privileges you must create the db manually before running this command. ``` bundle exec rake setup @@ -10,7 +10,7 @@ bundle exec rake setup ## Run tests -This runs all test suite present in GitLab +This runs all test suites present in GitLab. ``` bundle exec rake test @@ -18,7 +18,7 @@ bundle exec rake test ## Generate searchable docs for source code -You can find results under `doc/code` directory +You can find results under the `doc/code` directory. ``` bundle exec rake gitlab:generate_docs diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md index 2565acb8eff..5627fd0659f 100644 --- a/doc/markdown/markdown.md +++ b/doc/markdown/markdown.md @@ -139,37 +139,38 @@ But let's throw in a <b>tag</b>. ## Emoji - Sometimes you want to be :cool: and add some :sparkles: to your :speech_balloon:. Well we have a :gift: for you: + Sometimes you want to be a :ninja: and add some :glowing_star: to your :speech_balloon:. Well we have a gift for you: - :exclamation: You can use emoji anywhere GFM is supported. :sunglasses: + :high_voltage_sign: You can use emoji anywhere GFM is supported. :victory_hand: - You can use it to point out a :bug: or warn about :monkey:patches. And if someone improves your really :snail: code, send them a :bouquet: or some :candy:. People will :heart: you for that. + You can use it to point out a :bug: or warn about :speak_no_evil_monkey: patches. And if someone improves your really :snail: code, send them some :cake:. People will :heart: you for that. - If you are :new: to this, don't be :fearful:. You can easily join the emoji :circus_tent:. All you need to do is to :book: up on the supported codes. + If you are new to this, don't be :fearful_face:. You can easily join the emoji :family:. All you need to do is to look up on the supported codes. - Consult the [Emoji Cheat Sheet](http://www.emoji-cheat-sheet.com/) for a list of all supported emoji codes. :thumbsup: + Consult the [Emoji Cheat Sheet](https://www.dropbox.com/s/b9xaqb977s6d8w1/cheat_sheet.pdf) for a list of all supported emoji codes. :thumbsup: -Sometimes you want to be :cool: and add some :sparkles: to your :speech_balloon:. Well we have a :gift: for you: +Sometimes you want to be a :ninja: and add some :glowing_star: to your :speech_balloon:. Well we have a gift for you: -:exclamation: You can use emoji anywhere GFM is supported. :sunglasses: +:high_voltage_sign: You can use emoji anywhere GFM is supported. :victory_hand: -You can use it to point out a :bug: or warn about :monkey:patches. And if someone improves your really :snail: code, send them a :bouquet: or some :candy:. People will :heart: you for that. +You can use it to point out a :bug: or warn about :speak_no_evil_monkey: patches. And if someone improves your really :snail: code, send them some :cake:. People will :heart: you for that. -If you are :new: to this, don't be :fearful:. You can easily join the emoji :circus_tent:. All you need to do is to :book: up on the supported codes. +If you are new to this, don't be :fearful_face:. You can easily join the emoji :family:. All you need to do is to look up on the supported codes. -Consult the [Emoji Cheat Sheet](http://www.emoji-cheat-sheet.com/) for a list of all supported emoji codes. :thumbsup: +Consult the [Emoji Cheat Sheet](https://www.dropbox.com/s/b9xaqb977s6d8w1/cheat_sheet.pdf) for a list of all supported emoji codes. :thumbsup: ## Special GitLab References GFM recognized special references. -You can easily reference e.g. a team member, an issue, or a commit within a project. +You can easily reference e.g. an issue, a commit, a team member or even the whole team within a project. GFM will turn that reference into a link so you can navigate between them easily. GFM will recognize the following: - @foo : for team members +- @all : for the whole team - #123 : for issues - !123 : for merge requests - $123 : for snippets diff --git a/doc/update/4.2-to-5.0.md b/doc/update/4.2-to-5.0.md index 230c1e88b23..30b25a2d2d5 100644 --- a/doc/update/4.2-to-5.0.md +++ b/doc/update/4.2-to-5.0.md @@ -7,6 +7,7 @@ GitLab 5.0 is affected by critical security vulnerability CVE-2013-4490. ## Important changes - We don't use `gitlab` user any more. Everything will be moved to `git` user +- Self signed SSL certificates are not supported until GitLab 5.1 - **requires ruby1.9.3** ## 0. Stop gitlab @@ -162,3 +163,7 @@ sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production ``` **P.S. If everything works as expected you can remove gitlab user from system** + +```bash +sudo userdel -r gitlab +``` diff --git a/doc/update/5.1-to-6.0.md b/doc/update/5.1-to-6.0.md index d8484b2c650..123b3326ead 100644 --- a/doc/update/5.1-to-6.0.md +++ b/doc/update/5.1-to-6.0.md @@ -149,6 +149,12 @@ sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production The migrations in this update are very sensitive to incomplete or inconsistent data. If you have a long-running GitLab installation and some of the previous upgrades did not work out 100% correct this may bite you now. The following commands can be run in the rails console to look for 'bad' data. +Start rails console: + +``` +sudo -u git -H rails console production +``` + All project owners should have an owner: ``` diff --git a/doc/update/6.9-to-7.0.md b/doc/update/6.9-to-7.0.md index 70a30a58687..6a3dd59934b 100644 --- a/doc/update/6.9-to-7.0.md +++ b/doc/update/6.9-to-7.0.md @@ -103,7 +103,7 @@ sudo chmod +x /etc/init.d/gitlab There are new configuration options available for gitlab.yml. View them with the command below and apply them to your current gitlab.yml if desired. ``` -git diff 6-9-stable:config/gitlab.yml.example 7-0-stable:config/gitlab.yml.example +git diff origin/6-9-stable:config/gitlab.yml.example origin/7-0-stable:config/gitlab.yml.example ``` ### 7. Start application |