diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/container_registry.md | 4 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 18 |
2 files changed, 18 insertions, 4 deletions
diff --git a/doc/api/container_registry.md b/doc/api/container_registry.md index cb1a81b97b6..7e5e265351e 100644 --- a/doc/api/container_registry.md +++ b/doc/api/container_registry.md @@ -252,8 +252,8 @@ This action does not delete blobs. In order to delete them and recycle disk spac [run the garbage collection](https://docs.gitlab.com/omnibus/maintenance/README.html#removing-unused-layers-not-referenced-by-manifests). NOTE: **Note:** -Due to a [Docker Distribution deficiency](https://gitlab.com/gitlab-org/gitlab-foss/issues/21405), -it doesn't remove tags whose manifest is shared by multiple tags. +Since GitLab 12.4, individual tags are deleted. +For more details, see the [discussion](https://gitlab.com/gitlab-org/gitlab/issues/15737). Examples: diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 79797107a5b..32ac399925e 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -253,13 +253,13 @@ table_display_block: true --- ``` -## Emphasis +### Emphasis - Use double asterisks (`**`) to mark a word or text in bold (`**bold**`). - Use underscore (`_`) for text in italics (`_italic_`). - Use greater than (`>`) for blockquotes. -## Punctuation +### Punctuation Check the general punctuation rules for the GitLab documentation on the table below. Check specific punctuation rules for [lists](#lists) below. @@ -274,6 +274,20 @@ Check specific punctuation rules for [lists](#lists) below. | Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | _You should try this - or not._ | | Always use lowercase after a colon. | _Related Issues: a way to create a relationship between issues._ | +### Placeholder text + +Often in examples, a writer will provide a command or configuration that is complete apart from +a value specific to the reader. + +In these cases, use [`<` and `>`](https://en.wikipedia.org/wiki/Usage_message#Pattern) to call out +where a reader must replace text with their own value. + +For example: + +```sh +cp <your_source_directory> <your_destination_directory> +``` + ## Lists - Always start list items with a capital letter, unless they are parameters or commands |