diff options
Diffstat (limited to 'doc/user/snippets.md')
| -rw-r--r-- | doc/user/snippets.md | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/doc/user/snippets.md b/doc/user/snippets.md index 79d1751d13f..00014dc32ee 100644 --- a/doc/user/snippets.md +++ b/doc/user/snippets.md @@ -11,6 +11,44 @@ There are two types of snippets: - Personal snippets. - Project snippets. +## Personal snippets + +Personal snippets are not related to any project and can be created completely +independently. There are 3 visibility levels that can be set, public, internal +and private. See [Public access](../public_access/public_access.md) for more information. + +## Project snippets + +Project snippets are always related to a specific project. +See [Project features](project/index.md#project-features) for more information. + +## Create a snippet + +To create a personal snippet, click the plus icon (**{plus-square-o}**) +on the top navigation and select **New snippet** from the dropdown menu: + + + +If you're on a project's page but you want to create a new personal snippet, +click the plus icon (**{plus-square-o}**) and select **New snippet** from the +lower part of the dropdown (**GitLab** on GitLab.com; **Your Instance** on +self-managed instances): + + + +To create a project snippet, navigate to your project's page and click the +plus icon (**{plus-square-o}**), then select **New snippet** from the upper +part of the dropdown (**This project**). + + + +From there, add the **Title**, **Description**, and a **File** name with the +appropriate extension (for example, `example.rb`, `index.html`). + +CAUTION: **Warning:** +Make sure to add the file name to get code highlighting and to avoid this +[copy-pasting bug](https://gitlab.com/gitlab-org/gitlab/-/issues/22870). + ## Versioned Snippets > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/239) in GitLab 13.0. @@ -61,7 +99,7 @@ master branch. ### Limitations - Binary files are not supported. -- Creating or deleting branches is not supported. Only a default *master* +- Creating or deleting branches is not supported. Only a default *master*. branch is used. - Git tags are not supported in snippet repositories. - Snippets' repositories are limited to one file. Attempting to push more @@ -70,45 +108,7 @@ than one file will result in an error. it's planned to be added in future iterations. See the [revisions tab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/39271) for updates. - The [maximum size for a snippet](../administration/snippets/index.md#snippets-content-size-limit) -is 50MB, by default. - -## Personal snippets - -Personal snippets are not related to any project and can be created completely -independently. There are 3 visibility levels that can be set, public, internal -and private. See [Public access](../public_access/public_access.md) for more information. - -## Project snippets - -Project snippets are always related to a specific project. -See [Project features](project/index.md#project-features) for more information. - -## Create a snippet - -To create a personal snippet, click the plus icon (**{plus-square-o}**) -on the top navigation and select **New snippet** from the dropdown menu: - - - -If you're on a project's page but you want to create a new personal snippet, -click the plus icon (**{plus-square-o}**) and select **New snippet** from the -lower part of the dropdown (**GitLab** on GitLab.com; **Your Instance** on -self-managed instances): - - - -To create a project snippet, navigate to your project's page and click the -plus icon (**{plus-square-o}**), then select **New snippet** from the upper -part of the dropdown (**This project**). - - - -From there, add the **Title**, **Description**, and a **File** name with the -appropriate extension (for example, `example.rb`, `index.html`). - -CAUTION: **Warning:** -Make sure to add the file name to get code highlighting and to avoid this -[copy-pasting bug](https://gitlab.com/gitlab-org/gitlab/-/issues/22870). +is 50 MB, by default. ## Discover snippets |