cc9928c256
Docs: add the documentation guidelines into its own dir
2018-06-06 11:32:38 +00:00
3c9686c96d
Rename Secret variables -> variables
2018-06-06 11:28:54 +02:00
185f0a3982
Docs: update docs style guidelines
2018-05-09 14:45:55 +00:00
f703ba3f85
Docs: add custom descriptions to most relevant docs
2018-05-09 11:07:11 +00:00
12e3eff462
Fixed typos
2018-04-27 08:50:05 +00:00
d8cd3f4bf1
update badges guidelines
2018-04-17 13:35:42 -03:00
2654905ad5
document how badges work
2018-04-16 14:33:52 -03:00
536e57d54f
Docs: refactor doc general guidelines and style guidelines
2018-03-16 14:59:56 +00:00
650d11beb4
Docs: search/replace "Enterprise Edition" and adjust when applicable
2018-02-22 16:13:35 +00:00
0cbbb08e79
doc: Spelling fixes
2018-01-19 12:09:59 +02:00
b82c4f1b33
Merge branch 'master' into 'master'
...
Fix typo in doc_styleguide.md
See merge request gitlab-org/gitlab-ce!16481
2018-01-16 14:08:23 +00:00
228ff2c979
Docs: document new redirect for Disqus comments
2018-01-16 09:20:39 +00:00
d542099583
Fix typo in doc_styleguide.md
2018-01-15 23:57:13 +00:00
007e51f128
organise content by subject
2017-12-21 13:31:41 +00:00
6cf76d652d
Add underline hover state to all links
2017-12-04 11:00:52 +00:00
3f39d78795
Fix the redirect location wording
...
Closes https://gitlab.com/gitlab-com/gitlab-docs/issues/142
2017-11-23 12:52:26 +01:00
d0af6047bc
Update documentation
2017-11-02 12:53:26 +01:00
43dea824c1
use inline links instead of referenced
2017-08-18 16:44:28 -03:00
fa3e4ddff0
Remove mentions of SeanPackham since he's no longer with GitLab
2017-07-27 12:27:09 +00:00
63b66f1d0c
Fix wrong link to docs in docs styleguide
2017-07-16 19:12:56 +03:00
9e8ed540b7
Complement tech articles guidelines
2017-05-11 10:51:39 +00:00
371436b33c
add directory articles to hold all tech articles
2017-04-17 17:44:22 -03:00
df9fb04f87
add link to "writing docs" , fix typo
2017-03-28 23:35:03 -03:00
bbd5493428
add instructions on subtopics
2017-03-22 20:42:54 -03:00
dda8896e93
rename "documentation articles" to "technical articles"
2017-03-16 15:58:04 -03:00
e4cd6c683b
add topics dir to doc_styleguide
2017-03-16 15:54:23 -03:00
1ead6a9793
Use v4 endpoint in API docs
2017-03-01 18:39:40 +01:00
297c868398
Add guidelines in doc linking with HAML
...
[ci skip]
2016-11-28 18:27:29 +01:00
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
