Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
9e8ed540
Commit
9e8ed540
authored
May 11, 2017
by
Marcia Ramos
Committed by
Sean Packham (GitLab)
May 11, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Complement tech articles guidelines
parent
aec53bab
Changes
7
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
25 additions
and
12 deletions
+25
-12
doc/articles/how_to_configure_ldap_gitlab_ce/index.md
doc/articles/how_to_configure_ldap_gitlab_ce/index.md
+1
-1
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+8
-1
doc/development/writing_documentation.md
doc/development/writing_documentation.md
+4
-2
doc/user/project/pages/getting_started_part_four.md
doc/user/project/pages/getting_started_part_four.md
+3
-2
doc/user/project/pages/getting_started_part_one.md
doc/user/project/pages/getting_started_part_one.md
+3
-2
doc/user/project/pages/getting_started_part_three.md
doc/user/project/pages/getting_started_part_three.md
+3
-2
doc/user/project/pages/getting_started_part_two.md
doc/user/project/pages/getting_started_part_two.md
+3
-2
No files found.
doc/articles/how_to_configure_ldap_gitlab_ce/index.md
View file @
9e8ed540
# How to configure LDAP with GitLab CE
> **
Type
:** admin guide ||
> **
Article [Type](../../development/writing_documentation.html#types-of-technical-articles)
:** admin guide ||
> **Level:** intermediary ||
> **Author:** [Chris Wilson](https://gitlab.com/MrChrisW) ||
> **Publication date:** 2017/05/03
...
...
doc/development/doc_styleguide.md
View file @
9e8ed540
...
...
@@ -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
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
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.
-
Keep all file names in lower case.
-
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:
...
...
doc/development/writing_documentation.md
View file @
9e8ed540
...
...
@@ -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
**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 of the
**publication date**
```
md
> **
Type
:** tutorial ||
> **
Article [Type](../../development/writing_documentation.html#types-of-technical-articles)
:** tutorial ||
> **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
...
...
doc/user/project/pages/getting_started_part_four.md
View file @
9e8ed540
# 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 ||
> **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 2: Quick start guide - Setting up GitLab Pages
](
getting_started_part_two.md
)
...
...
doc/user/project/pages/getting_started_part_one.md
View file @
9e8ed540
# 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 ||
> **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 2: Quick start guide - Setting up GitLab Pages
](
getting_started_part_two.md
)
...
...
doc/user/project/pages/getting_started_part_three.md
View file @
9e8ed540
# 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 ||
> **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 2: Quick start guide - Setting up GitLab Pages
](
getting_started_part_two.md
)
...
...
doc/user/project/pages/getting_started_part_two.md
View file @
9e8ed540
# 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 ||
> **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 2: Quick start guide - Setting up GitLab Pages**
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment