diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-20 12:11:29 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-20 12:11:29 +0000 |
commit | 7b384a1f3d2608898318e67d11eea2914889ae81 (patch) | |
tree | af33e77d13b18a96156c69616cb09a3a4f7697c6 /doc/development/documentation | |
parent | d46287cc16ba244720c6d5c00491944336972988 (diff) | |
download | gitlab-ce-7b384a1f3d2608898318e67d11eea2914889ae81.tar.gz |
Add latest changes from gitlab-org/gitlab@12-3-stable
Diffstat (limited to 'doc/development/documentation')
-rw-r--r-- | doc/development/documentation/improvement-workflow.md | 4 | ||||
-rw-r--r-- | doc/development/documentation/site_architecture/index.md | 4 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 18 |
3 files changed, 6 insertions, 20 deletions
diff --git a/doc/development/documentation/improvement-workflow.md b/doc/development/documentation/improvement-workflow.md index c8e9368fb74..9f3b789712f 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 technical writer's review +If the author or reviewer has any questions, or would like a techncial 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. diff --git a/doc/development/documentation/site_architecture/index.md b/doc/development/documentation/site_architecture/index.md index f8d63a54053..bb598906967 100644 --- a/doc/development/documentation/site_architecture/index.md +++ b/doc/development/documentation/site_architecture/index.md @@ -18,8 +18,8 @@ from where content is sourced, the `gitlab-docs` project, and the published outp ```mermaid graph LR - A[gitlab-foss/doc] - B[gitlab/doc] + A[gitlab-ce/doc] + B[gitlab-ee/doc] C[gitlab-runner/docs] D[omnibus-gitlab/doc] E[charts/doc] diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 32ac399925e..79797107a5b 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,20 +274,6 @@ 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 |