Commit 9e8ed540 authored by Marcia Ramos's avatar Marcia Ramos Committed by Sean Packham (GitLab)

Complement tech articles guidelines

parent aec53bab
# How to configure LDAP with GitLab CE # How to configure LDAP with GitLab CE
> **Type:** admin guide || > **Article [Type](../../development/writing_documentation.html#types-of-technical-articles):** admin guide ||
> **Level:** intermediary || > **Level:** intermediary ||
> **Author:** [Chris Wilson](https://gitlab.com/MrChrisW) || > **Author:** [Chris Wilson](https://gitlab.com/MrChrisW) ||
> **Publication date:** 2017/05/03 > **Publication date:** 2017/05/03
......
...@@ -198,10 +198,17 @@ You can combine one or more of the following: ...@@ -198,10 +198,17 @@ You can combine one or more of the following:
the `.md` document that you're working on is located. Always prepend their the `.md` document that you're working on is located. Always prepend their
names with the name of the document that they will be included in. For names with the name of the document that they will be included in. For
example, if there is a document called `twitter.md`, then a valid image name example, if there is a document called `twitter.md`, then a valid image name
could be `twitter_login_screen.png`. could be `twitter_login_screen.png`. [**Exception**: images for
[articles](writing_documentation.md#technical-articles) should be
put in a directory called `img` underneath `/articles/article_title/img/`, therefore,
there's no need to prepend the document name to their filenames.]
- Images should have a specific, non-generic name that will differentiate them. - Images should have a specific, non-generic name that will differentiate them.
- Keep all file names in lower case. - Keep all file names in lower case.
- Consider using PNG images instead of JPEG. - Consider using PNG images instead of JPEG.
- Compress all images with <https://tinypng.com/> or similar tool.
- Compress gifs with <https://ezgif.com/optimize> or similar toll.
- Images should be used (only when necessary) to _illustrate_ the description
of a process, not to _replace_ it.
Inside the document: Inside the document:
......
...@@ -52,11 +52,13 @@ Every **Technical Article** contains, in the very beginning, a blockquote with t ...@@ -52,11 +52,13 @@ Every **Technical Article** contains, in the very beginning, a blockquote with t
- A reference to the **type of article** (user guide, admin guide, tech overview, tutorial) - A reference to the **type of article** (user guide, admin guide, tech overview, tutorial)
- A reference to the **knowledge level** expected from the reader to be able to follow through (beginner, intermediate, advanced) - A reference to the **knowledge level** expected from the reader to be able to follow through (beginner, intermediate, advanced)
- A reference to the **author's name** and **GitLab.com handle** - A reference to the **author's name** and **GitLab.com handle**
- A reference of the **publication date**
```md ```md
> **Type:** tutorial || > **Article [Type](../../development/writing_documentation.html#types-of-technical-articles):** tutorial ||
> **Level:** intermediary || > **Level:** intermediary ||
> **Author:** [Name Surname](https://gitlab.com/username) > **Author:** [Name Surname](https://gitlab.com/username) ||
> **Publication date:** AAAA/MM/DD
``` ```
#### Technical Articles - Writing Method #### Technical Articles - Writing Method
......
# GitLab Pages from A to Z: Part 4 # GitLab Pages from A to Z: Part 4
> **Type**: user guide || > **Article [Type](../../../development/writing_documentation.html#types-of-technical-articles)**: user guide ||
> **Level**: intermediate || > **Level**: intermediate ||
> **Author**: [Marcia Ramos](https://gitlab.com/marcia) > **Author**: [Marcia Ramos](https://gitlab.com/marcia) ||
> **Publication date:** 2017/02/22
- [Part 1: Static sites and GitLab Pages domains](getting_started_part_one.md) - [Part 1: Static sites and GitLab Pages domains](getting_started_part_one.md)
- [Part 2: Quick start guide - Setting up GitLab Pages](getting_started_part_two.md) - [Part 2: Quick start guide - Setting up GitLab Pages](getting_started_part_two.md)
......
# GitLab Pages from A to Z: Part 1 # GitLab Pages from A to Z: Part 1
> **Type**: user guide || > **Article [Type](../../../development/writing_documentation.html#types-of-technical-articles)**: user guide ||
> **Level**: beginner || > **Level**: beginner ||
> **Author**: [Marcia Ramos](https://gitlab.com/marcia) > **Author**: [Marcia Ramos](https://gitlab.com/marcia) ||
> **Publication date:** 2017/02/22
- **Part 1: Static sites and GitLab Pages domains** - **Part 1: Static sites and GitLab Pages domains**
- [Part 2: Quick start guide - Setting up GitLab Pages](getting_started_part_two.md) - [Part 2: Quick start guide - Setting up GitLab Pages](getting_started_part_two.md)
......
# GitLab Pages from A to Z: Part 3 # GitLab Pages from A to Z: Part 3
> **Type**: user guide || > **Article [Type](../../../development/writing_documentation.html#types-of-technical-articles)**: user guide ||
> **Level**: beginner || > **Level**: beginner ||
> **Author**: [Marcia Ramos](https://gitlab.com/marcia) > **Author**: [Marcia Ramos](https://gitlab.com/marcia) ||
> **Publication date:** 2017/02/22
- [Part 1: Static sites and GitLab Pages domains](getting_started_part_one.md) - [Part 1: Static sites and GitLab Pages domains](getting_started_part_one.md)
- [Part 2: Quick start guide - Setting up GitLab Pages](getting_started_part_two.md) - [Part 2: Quick start guide - Setting up GitLab Pages](getting_started_part_two.md)
......
# GitLab Pages from A to Z: Part 2 # GitLab Pages from A to Z: Part 2
> **Type**: user guide || > **Article [Type](../../../development/writing_documentation.html#types-of-technical-articles)**: user guide ||
> **Level**: beginner || > **Level**: beginner ||
> **Author**: [Marcia Ramos](https://gitlab.com/marcia) > **Author**: [Marcia Ramos](https://gitlab.com/marcia) ||
> **Publication date:** 2017/02/22
- [Part 1: Static sites and GitLab Pages domains](getting_started_part_one.md) - [Part 1: Static sites and GitLab Pages domains](getting_started_part_one.md)
- **Part 2: Quick start guide - Setting up GitLab Pages** - **Part 2: Quick start guide - Setting up GitLab Pages**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment