diff options
| author | Onuwa Nnachi Isaac <matrix4u2002@gmail.com> | 2018-01-02 19:06:11 +0100 |
|---|---|---|
| committer | Onuwa Nnachi Isaac <matrix4u2002@gmail.com> | 2018-01-02 19:06:11 +0100 |
| commit | 3d5e4e34ca30f083e0f6ea0bbfe1a28c2f8f4b63 (patch) | |
| tree | 5f60bfac3a7ce45d7e7f546b9a0e2c8409a6e01e | |
| parent | 723d788fbef90b270cce1ca1d4bc228c54041eaa (diff) | |
| download | gitlab-ce-3d5e4e34ca30f083e0f6ea0bbfe1a28c2f8f4b63.tar.gz | |
Fix typo in writing_documentation.md
| -rw-r--r-- | doc/development/writing_documentation.md | 4 | ||||
| l--------- | doc/doc | 1 |
2 files changed, 3 insertions, 2 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index 43a79ffcaa5..133ac0234cf 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -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 changes are introduced to the UI. -The one resposible for writing the first piece of documentation is the developer who +The one responsible 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 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, @@ -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 **use cases**. Every GitLab EE-only feature should also contain these sections. -**Overview**: at the name suggests, the goal here is to provide an overview of the feature. +**Overview**: as 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, what problem it solves, and what you can do with this feature that you couldn't do before. diff --git a/doc/doc b/doc/doc new file mode 120000 index 00000000000..e78a24e7fe6 --- /dev/null +++ b/doc/doc @@ -0,0 +1 @@ +/home/isaac/apps/opensource/GitLab/gitlab-ce/doc
\ No newline at end of file |