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
Jérome Perrin
gitlab-ce
Commits
3d5e4e34
Commit
3d5e4e34
authored
Jan 02, 2018
by
Onuwa Nnachi Isaac
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix typo in writing_documentation.md
parent
723d788f
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
3 additions
and
2 deletions
+3
-2
doc/development/writing_documentation.md
doc/development/writing_documentation.md
+2
-2
doc/doc
doc/doc
+1
-0
No files found.
doc/development/writing_documentation.md
View file @
3d5e4e34
...
@@ -15,7 +15,7 @@ request introducing these changes must be accompanied by the documentation
...
@@ -15,7 +15,7 @@ request introducing these changes must be accompanied by the documentation
(either updating existing ones or creating new ones). This is also valid when
(either updating existing ones or creating new ones). This is also valid when
changes are introduced to the UI.
changes are introduced to the UI.
The one resposible for writing the first piece of documentation is the developer who
The one respo
n
sible for writing the first piece of documentation is the developer who
wrote the code. It's the job of the Product Manager to ensure all features are
wrote the code. It's the job of the Product Manager to ensure all features are
shipped with its docs, whether is a small or big change. At the pace GitLab evolves,
shipped with its docs, whether is a small or big change. At the pace GitLab evolves,
this is the only way to keep the docs up-to-date. If you have any questions about it,
this is the only way to keep the docs up-to-date. If you have any questions about it,
...
@@ -31,7 +31,7 @@ Every major feature (regardless if present in GitLab Community or Enterprise edi
...
@@ -31,7 +31,7 @@ Every major feature (regardless if present in GitLab Community or Enterprise edi
should present, at the beginning of the document, two main sections:
**overview**
and
should present, at the beginning of the document, two main sections:
**overview**
and
**use cases**
. Every GitLab EE-only feature should also contain these sections.
**use cases**
. Every GitLab EE-only feature should also contain these sections.
**Overview**
: a
t
the name suggests, the goal here is to provide an overview of the feature.
**Overview**
: a
s
the name suggests, the goal here is to provide an overview of the feature.
Describe what is it, what it does, why it is important/cool/nice-to-have,
Describe what is it, what it does, why it is important/cool/nice-to-have,
what problem it solves, and what you can do with this feature that you couldn't
what problem it solves, and what you can do with this feature that you couldn't
do before.
do before.
...
...
doc/doc
0 → 120000
View file @
3d5e4e34
/home/isaac/apps/opensource/GitLab/gitlab-ce/doc
\ No newline at end of file
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