diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-19 09:06:27 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-19 09:06:27 +0000 |
commit | b3e0658cb1fbc7c8e7dd381467c656f2e675ee46 (patch) | |
tree | 56f0231bca8a7f45bcd88da2b716e6b672e6f602 /doc | |
parent | 82a534c245f830d7692d03c557075f211bec6e75 (diff) | |
download | gitlab-ce-b3e0658cb1fbc7c8e7dd381467c656f2e675ee46.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/tags.md | 6 | ||||
-rw-r--r-- | doc/api/users.md | 29 | ||||
-rw-r--r-- | doc/development/documentation/improvement-workflow.md | 4 |
3 files changed, 23 insertions, 16 deletions
diff --git a/doc/api/tags.md b/doc/api/tags.md index 3807688ffe3..56143969e3c 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -116,6 +116,12 @@ Parameters: - `message` (optional) - Creates annotated tag. - `release_description` (optional) - Add release notes to the Git tag and store it in the GitLab database. +```bash +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/tags?tag_name=test&ref=master" +``` + +Example response: + ```json { "commit": { diff --git a/doc/api/users.md b/doc/api/users.md index 380396c7377..251c11198e1 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -393,20 +393,21 @@ PUT /users/:id Parameters: -- `email` - Email -- `username` - Username -- `name` - Name -- `password` - Password -- `skype` - Skype ID -- `linkedin` - LinkedIn -- `twitter` - Twitter account -- `website_url` - Website URL -- `organization` - Organization name -- `projects_limit` - Limit projects each user can create -- `extern_uid` - External UID -- `provider` - External provider name +- `id` (required) - The ID of the user +- `email` (optional) - Email +- `username` (optional) - Username +- `name` (optional) - Name +- `password` (optional) - Password +- `skype` (optional) - Skype ID +- `linkedin` (optional) - LinkedIn +- `twitter` (optional) - Twitter account +- `website_url` (optional) - Website URL +- `organization` (optional) - Organization name +- `projects_limit` (optional) - Limit projects each user can create +- `extern_uid` (optional) - External UID +- `provider` (optional) - External provider name - `group_id_for_saml` (optional) - ID of group where SAML has been configured -- `bio` - User's biography +- `bio` (optional) - User's biography - `location` (optional) - User's location - `public_email` (optional) - The public email of the user - `admin` (optional) - User is admin - true or false (default) @@ -419,7 +420,7 @@ Parameters: - `private_profile` (optional) - User's profile is private - true or false (default) - `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)** - `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)** -- `note` (optional) - Admin notes for this user **(STARTER)** +- `note` (optional) - Admin notes for this user **(STARTER)** On password update, user will be forced to change it upon next login. Note, at the moment this method does only return a `404` error, diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index 9f3b789712f..c8e9368fb74 100644 --- a/doc/development/documentation/improvement-workflow.md +++ b/doc/development/documentation/improvement-workflow.md @@ -28,7 +28,7 @@ to accomplish their work with GitLab. 1. Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). If you need any help to choose the correct place for a doc, discuss a documentation -idea or outline, or request any other help, ping the Technical Writer for the relevant +idea or outline, or request any other help, ping the technical writer for the relevant [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages) in your issue or MR, or write within `#docs` if you are a member of GitLab's Slack workspace. @@ -39,7 +39,7 @@ This person must make a good-faith effort to ensure that the content is clear (sufficiently easy for the intended audience to navigate and understand) and that it meets the [Documentation Guidelines](index.md) and [Style Guide](styleguide.md). -If the author or reviewer has any questions, or would like a techncial writer's review +If the author or reviewer has any questions, or would like a technical writer's review before merging, mention the writer who is assigned to the relevant [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). The process can involve the following parties/phases, and is replicated in the `Documentation` MR template for GitLab CE and EE, to help with following the process. |