8a998b632a
Change a bunch of doc links to either relative or https://docs.gitlab.com .
2016-11-03 15:11:51 -06:00
69ab287b36
Add note about ephemeral statuses in headings
...
[ci skip]
2016-10-27 08:26:35 +02:00
65d86e0d11
Merge branch 'improve-grape-dsl-rules' into 'master'
...
Add an API styleguide
This adds a styleguide for API development. Spinned-of from https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6860#note_16922017 .
[ci skip]
See merge request !6864
2016-10-25 15:12:43 +00:00
a4fa44ce90
Merge branch 'master' into 'docs/change-docs-reviewers'
...
# Conflicts:
# doc/development/doc_styleguide.md
2016-10-16 18:16:50 +00:00
5174b7ad7e
Add the tech writers usernames in the doc_sytleguide doc
...
[ci skip]
2016-10-16 11:35:51 +02:00
54c0286a3f
remove ashley since she no longer works here
2016-10-15 10:59:40 +02:00
c1dd1795ed
Move the Grape DSL part from Doc styleguide to API styleguide
...
Also improve API styleguide
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-13 19:35:57 +02:00
ce8aedf030
Add examples of fake tokens to be used in docs
...
[ci skip]
2016-10-11 15:39:14 +02:00
3ef2c38b63
Change the inline code to codeblocks for the new features doc guideline
...
[ci skip]
2016-09-02 08:55:54 +02:00
773bca382b
Merge branch 'doc/styleguide-fix-grep' into 'master'
...
Clarify steps when changing a document's location
Clarify the steps needed to change a document's location so issues like
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6024
don't occur.
See merge request !6070
2016-08-29 20:13:49 +00:00
d30d992813
Use `git grep` instead of `grep`
...
[ci skip]
2016-08-29 22:08:02 +02:00
8044797559
Clarify steps when changing a document's location
...
[ci skip]
2016-08-27 20:52:13 +02:00
aeb280b0cc
Fix markdown help references
2016-08-26 09:38:21 -05:00
cb5e6fe71e
Fix markdown link in doc_styleguide.md
...
[ci skip]
2016-08-25 15:36:56 +02:00
e0a858efcc
use long options for curl examples in API documentation ( !5703 )
2016-08-09 01:42:50 +02:00
689de9c6fb
Simplify feature introduction note
...
[ci skip]
2016-08-08 11:44:55 +03:00
ff4407996b
Add doc guidelines on documents naming and location
...
[ci skip]
2016-08-03 17:06:04 +03:00
8bcdc4b185
API methods should be documented using Grape's DSL
...
See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2397#note_13491048
2016-08-01 13:52:51 +00:00
c71e658cca
Refactor and rename `restricted_signup_domains` to `domain_whitelist` to better conform to its behavior and newly introduced behavior.
2016-07-18 17:53:43 -05:00
52af77d8f8
Don't ask Heather to review documentation MR's
2016-07-15 16:04:45 +00:00
dd417699a3
Add styleguide on configuration settings documentation
...
[ci skip]
2016-06-20 13:32:54 +02:00
aa48eeef17
Merge branch 'doc-styleguide-move-locations' into 'master'
...
Add guide on changing a document's location
## What does this MR do?
Add a documentation styleguide when changing a document's location.
## What are the relevant issue numbers?
https://gitlab.com/gitlab-org/gitlab-ce/issues/3349
See merge request !4624
2016-06-13 13:26:43 +00:00
cb7fa10cb5
Change to new Notes styleguide
...
[ci skip]
2016-06-13 15:04:22 +02:00
d1abbb3b66
Add guide on changing a document's location
...
[ci skip]
2016-06-13 15:00:28 +02:00
9eb4569ed9
Change all occurrences of doc.gitlab.com to docs.gitlab.com
...
[ci skip]
2016-05-13 16:26:56 -05:00
bfeab78ab5
Change doc styleguide to use quotes for notes
...
[ci skip]
2016-02-29 15:00:40 +02:00
a95c6e38c6
Add ruby version update info in doc_styleguide
...
[ci skip]
2016-02-05 17:26:40 +02:00
086cbca6bf
Link to restart_gitlab.md and some more fixes
...
[ci skip]
2016-01-20 10:44:26 +01:00
9d756f3d8b
Add document on restarting GitLab
...
[ci skip]
2016-01-20 10:33:59 +01:00
4eae95c03c
Update doc_styleguide.md [ci skip]
...
- Fix some syntax/grammar typos
- Link to GFM documentation on newlines
- Be less strict on the alphabetical order styleguide
- You can override the "numbers in headings" rule if you discuss it first
- Do not mention CE in notes if the feature is in both CE and EE
2016-01-13 18:24:08 +01:00
20c327fcfd
Clarify the naming guideline
...
[ci skip]
2016-01-12 16:19:11 +01:00
d0b2d278f4
Move doc_styleguide in the development directory
...
[ci skip]
2016-01-12 11:57:42 +01:00
Connor Shea