diff options
| author | Evan Read <eread@gitlab.com> | 2019-07-01 09:40:12 +1000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-07-02 08:55:34 +1000 |
| commit | b156e7e7391f356e51d18c2b4b3a7d23b687c971 (patch) | |
| tree | b84bee66e6b798f7e6232b3b36c0571a7a9fd284 /doc/development/documentation | |
| parent | 5e10faa3450a28e24b17d7f81a53d686328fd50d (diff) | |
| download | gitlab-ce-fix-bare-urls-in-projects.tar.gz | |
Fix most bare URLs in projectfix-bare-urls-in-projects
Linting rule not enabled for now
because tooling produces false
positives.
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/styleguide.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 0d82f905bf3..6bfedcb1047 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -151,7 +151,7 @@ The table below shows what kind of documentation goes where. applies to images. 1. For image files, do not exceed 100KB. 1. Do not upload video files to the product repositories. -[Link or embed videos](#videos) instead. + [Link or embed videos](#videos) instead. 1. There are four main directories, `user`, `administration`, `api` and `development`. 1. The `doc/user/` directory has five main subdirectories: `project/`, `group/`, `profile/`, `dashboard/` and `admin_area/`. @@ -179,7 +179,7 @@ The table below shows what kind of documentation goes where. If you are unsure where a document or a content addition should live, this should not stop you from authoring and contributing. You can use your best judgment and then ask the reviewer of your MR to confirm your decision, and/or ask a technical writer -at any stage in the process. The techncial writing team will review all documentation +at any stage in the process. The technical writing team will review all documentation changes, regardless, and can move content if there is a better place for it. ### Avoid duplication @@ -476,7 +476,7 @@ Do not upload videos to the product repositories. [Link](#link-to-video) or [emb ### Link to video -To link out to a video, include a YouTube icon so that readers can +To link out to a video, include a YouTube icon so that readers can quickly and easily scan the page for videos before reading: ```md |