Merge branch 'simplify_intro_features_doc' into 'master'
Simplify feature introduction note See merge request !5705
This commit is contained in:
commit
685c048d62
21 changed files with 55 additions and 58 deletions
|
@ -1,7 +1,6 @@
|
|||
# GitLab Container Registry Administration
|
||||
|
||||
> **Note:**
|
||||
This feature was [introduced][ce-4040] in GitLab 8.8.
|
||||
> [Introduced][ce-4040] in GitLab 8.8.
|
||||
|
||||
With the Docker Container Registry integrated into GitLab, every project can
|
||||
have its own space to store its Docker images.
|
||||
|
|
|
@ -44,8 +44,7 @@ as appropriate.
|
|||
|
||||
## Custom error messages
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][5073] in GitLab 8.10.
|
||||
> [Introduced][5073] in GitLab 8.10.
|
||||
|
||||
If the commit is declined or an error occurs during the Git hook check,
|
||||
the STDERR or STDOUT message of the hook will be present in GitLab's UI.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Housekeeping
|
||||
|
||||
_**Note:** This feature was [introduced][ce-2371] in GitLab 8.4_
|
||||
> [Introduced][ce-2371] in GitLab 8.4.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -1,13 +1,14 @@
|
|||
# Project import/export
|
||||
|
||||
>**Note:**
|
||||
- This feature was [introduced][ce-3050] in GitLab 8.9
|
||||
- Importing will not be possible if the import instance version is lower
|
||||
than that of the exporter.
|
||||
- For existing installations, the project import option has to be enabled in
|
||||
application settings (`/admin/application_settings`) under 'Import sources'.
|
||||
- The exports are stored in a temporary [shared directory][tmp] and are deleted
|
||||
every 24 hours by a specific worker.
|
||||
>
|
||||
> - [Introduced][ce-3050] in GitLab 8.9.
|
||||
> - Importing will not be possible if the import instance version is lower
|
||||
> than that of the exporter.
|
||||
> - For existing installations, the project import option has to be enabled in
|
||||
> application settings (`/admin/application_settings`) under 'Import sources'.
|
||||
> - The exports are stored in a temporary [shared directory][tmp] and are deleted
|
||||
> every 24 hours by a specific worker.
|
||||
|
||||
The GitLab Import/Export version can be checked by using:
|
||||
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
# Repository checks
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][ce-3232] in GitLab 8.7. It is OFF by
|
||||
default because it still causes too many false alarms.
|
||||
> [Introduced][ce-3232] in GitLab 8.7. It is OFF by default because it still
|
||||
causes too many false alarms.
|
||||
|
||||
Git has a built-in mechanism, [git fsck][git-fsck], to verify the
|
||||
integrity of all data committed to a repository. GitLab administrators
|
||||
|
|
|
@ -81,7 +81,7 @@ Read more about [GitLab as an OAuth2 client](oauth2.md).
|
|||
|
||||
### Personal Access Tokens
|
||||
|
||||
> **Note:** This feature was [introduced][ce-3749] in GitLab 8.8
|
||||
> [Introduced][ce-3749] in GitLab 8.8.
|
||||
|
||||
You can create as many personal access tokens as you like from your GitLab
|
||||
profile (`/profile/personal_access_tokens`); perhaps one for each application
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Award Emoji
|
||||
|
||||
>**Note:** This feature was introduced in GitLab 8.9
|
||||
> [Introduced][ce-4575] in GitLab 8.9.
|
||||
|
||||
An awarded emoji tells a thousand words, and can be awarded on issues, merge
|
||||
requests and notes/comments. Issues, merge requests and notes are further called
|
||||
|
@ -365,3 +365,5 @@ Example Response:
|
|||
"awardable_type": "Note"
|
||||
}
|
||||
```
|
||||
|
||||
[ce-4575]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4575
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Todos
|
||||
|
||||
**Note:** This feature was [introduced][ce-3188] in GitLab 8.10
|
||||
> [Introduced][ce-3188] in GitLab 8.10.
|
||||
|
||||
## Get a list of todos
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Triggering Builds through the API
|
||||
|
||||
_**Note:** This feature was [introduced][ci-229] in GitLab CE 7.14_
|
||||
> [Introduced][ci-229] in GitLab CE 7.14.
|
||||
|
||||
Triggers can be used to force a rebuild of a specific branch, tag or commit,
|
||||
with an API call.
|
||||
|
|
|
@ -1,8 +1,7 @@
|
|||
# GitLab Container Registry
|
||||
|
||||
> **Note:**
|
||||
This feature was [introduced][ce-4040] in GitLab 8.8. Docker Registry manifest
|
||||
v1 support was added in GitLab 8.9 to support Docker versions earlier than 1.10.
|
||||
> [Introduced][ce-4040] in GitLab 8.8. Docker Registry manifest
|
||||
`v1` support was added in GitLab 8.9 to support Docker versions earlier than 1.10.
|
||||
|
||||
> **Note:**
|
||||
This document is about the user guide. To learn how to enable GitLab Container
|
||||
|
|
|
@ -155,15 +155,15 @@ Inside the document:
|
|||
|
||||
- Every piece of documentation that comes with a new feature should declare the
|
||||
GitLab version that feature got introduced. Right below the heading add a
|
||||
note: `>**Note:** This feature was introduced in GitLab 8.3`
|
||||
note: `> Introduced in GitLab 8.3.`.
|
||||
- If possible every feature should have a link to the MR that introduced it.
|
||||
The above note would be then transformed to:
|
||||
`>**Note:** This feature was [introduced][ce-1242] in GitLab 8.3`, where
|
||||
`> [Introduced][ce-1242] in GitLab 8.3.`, where
|
||||
the [link identifier](#links) is named after the repository (CE) and the MR
|
||||
number
|
||||
number.
|
||||
- If the feature is only in GitLab EE, don't forget to mention it, like:
|
||||
`>**Note:** This feature was introduced in GitLab EE 8.3`. Otherwise, leave
|
||||
this mention out
|
||||
`> Introduced in GitLab EE 8.3.`. Otherwise, leave
|
||||
this mention out.
|
||||
|
||||
## References
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Health Check
|
||||
|
||||
>**Note:** This feature was [introduced][ce-3888] in GitLab 8.8.
|
||||
> [Introduced][ce-3888] in GitLab 8.8.
|
||||
|
||||
GitLab provides a health check endpoint for uptime monitoring on the `health_check` web
|
||||
endpoint. The health check reports on the overall system status based on the status of
|
||||
|
|
|
@ -46,10 +46,11 @@ When you are ready press the **Create label** button to create the new label.
|
|||
## Prioritize labels
|
||||
|
||||
>**Notes:**
|
||||
- This feature was introduced in GitLab 8.9.
|
||||
- Priority sorting is based on the highest priority label only. This might
|
||||
change in the future, follow the discussion in
|
||||
https://gitlab.com/gitlab-org/gitlab-ce/issues/18554.
|
||||
>
|
||||
> - Introduced in GitLab 8.9.
|
||||
> - Priority sorting is based on the highest priority label only. This might
|
||||
> change in the future, follow the discussion in
|
||||
> https://gitlab.com/gitlab-org/gitlab-ce/issues/18554.
|
||||
|
||||
Prioritized labels are like any other label, but sorted by priority. This allows
|
||||
you to sort issues and merge requests by priority.
|
||||
|
@ -87,8 +88,7 @@ important.
|
|||
|
||||
## Create a new label right from the issue tracker
|
||||
|
||||
>**Note:**
|
||||
This feature was introduced in GitLab 8.6.
|
||||
> Introduced in GitLab 8.6.
|
||||
|
||||
There are times when you are already in the issue tracker searching for a
|
||||
label, only to realize it doesn't exist. Instead of going to the **Labels**
|
||||
|
|
|
@ -47,8 +47,7 @@ creation.
|
|||
|
||||
## Wildcard protected branches
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][ce-4665] in GitLab 8.10.
|
||||
> [Introduced][ce-4665] in GitLab 8.10.
|
||||
|
||||
You can specify a wildcard protected branch, which will protect all branches
|
||||
matching the wildcard. For example:
|
||||
|
|
|
@ -1,18 +1,19 @@
|
|||
# Project import/export
|
||||
|
||||
>**Notes:**
|
||||
- This feature was [introduced][ce-3050] in GitLab 8.9
|
||||
- Importing will not be possible if the import instance version is lower
|
||||
than that of the exporter.
|
||||
- For existing installations, the project import option has to be enabled in
|
||||
application settings (`/admin/application_settings`) under 'Import sources'.
|
||||
Ask your administrator if you don't see the **GitLab export** button when
|
||||
creating a new project.
|
||||
- You can find some useful raketasks if you are an administrator in the
|
||||
[import_export](../../../administration/raketasks/project_import_export.md)
|
||||
raketask.
|
||||
- The exports are stored in a temporary [shared directory][tmp] and are deleted
|
||||
every 24 hours by a specific worker.
|
||||
>
|
||||
> - [Introduced][ce-3050] in GitLab 8.9.
|
||||
> - Importing will not be possible if the import instance version is lower
|
||||
> than that of the exporter.
|
||||
> - For existing installations, the project import option has to be enabled in
|
||||
> application settings (`/admin/application_settings`) under 'Import sources'.
|
||||
> Ask your administrator if you don't see the **GitLab export** button when
|
||||
> creating a new project.
|
||||
> - You can find some useful raketasks if you are an administrator in the
|
||||
> [import_export](../../../administration/raketasks/project_import_export.md)
|
||||
> raketask.
|
||||
> - The exports are stored in a temporary [shared directory][tmp] and are deleted
|
||||
> every 24 hours by a specific worker.
|
||||
|
||||
Existing projects running on any GitLab instance or GitLab.com can be exported
|
||||
with all their related data and be moved into a new GitLab instance.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# Award emoji
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][1825] in GitLab 8.2.
|
||||
[Introduced][1825] in GitLab 8.2.
|
||||
|
||||
When you're collaborating online, you get fewer opportunities for high-fives
|
||||
and thumbs-ups. Emoji can be awarded to issues and merge requests, making
|
||||
|
@ -16,7 +16,7 @@ award emoji.
|
|||
## Sort issues and merge requests on vote count
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][2871] in GitLab 8.5.
|
||||
[Introduced][2871] in GitLab 8.5.
|
||||
|
||||
You can quickly sort issues and merge requests by the number of votes they
|
||||
have received. The sort options can be found in the dropdown menu as "Most
|
||||
|
@ -45,7 +45,7 @@ downvotes.
|
|||
## Award emoji for comments
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][4291] in GitLab 8.9.
|
||||
[Introduced][4291] in GitLab 8.9.
|
||||
|
||||
Award emoji can also be applied to individual comments when you want to
|
||||
celebrate an accomplishment or agree with an opinion.
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
# Cherry-pick changes
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][ce-3514] in GitLab 8.7.
|
||||
> [Introduced][ce-3514] in GitLab 8.7.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# File finder
|
||||
|
||||
_**Note:** This feature was [introduced][gh-9889] in GitLab 8.4._
|
||||
> [Introduced][gh-9889] in GitLab 8.4.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Reverting changes
|
||||
|
||||
_**Note:** This feature was [introduced][ce-1990] in GitLab 8.5._
|
||||
> [Introduced][ce-1990] in GitLab 8.5.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# GitLab Todos
|
||||
|
||||
>**Note:** This feature was [introduced][ce-2817] in GitLab 8.5.
|
||||
> [Introduced][ce-2817] in GitLab 8.5.
|
||||
|
||||
When you log into GitLab, you normally want to see where you should spend your
|
||||
time and take some action, or what you need to keep an eye on. All without the
|
||||
|
|
|
@ -70,8 +70,7 @@ There are multiple ways to create a branch from GitLab's web interface.
|
|||
|
||||
### Create a new branch from an issue
|
||||
|
||||
>**Note:**
|
||||
This feature was [introduced][ce-2808] in GitLab 8.6.
|
||||
> [Introduced][ce-2808] in GitLab 8.6.
|
||||
|
||||
In case your development workflow dictates to have an issue for every merge
|
||||
request, you can quickly create a branch right on the issue page which will be
|
||||
|
|
Loading…
Reference in a new issue