Commit Graph

25 Commits

Author SHA1 Message Date
Marcel Amirault 6e2570d2d5 Docs: Update Variable naming 2018-11-11 23:43:25 +00:00
Evan Read 8c9da81cda Add refined sample linting configuration
Also:

- Ensures documentation section adheres to linters.
- Makes other minor improvements.
2018-11-06 13:14:39 +10:00
Marcia Ramos 6afcc3992b Merge branch 'docs/troubleshooting-docs-ra' into 'master'
Split troubleshooting docs review apps in own section

See merge request gitlab-org/gitlab-ce!22462
2018-10-18 14:05:23 +00:00
Achilleas Pipinellis a9049cc9da
Split troubleshooting docs review apps in own section 2018-10-18 15:54:54 +02:00
Marcia Ramos 275325b0a0 Documents help and feedback section and Disqus
- Links to MRs that introduced them
- Explains how to omit them
- Follows https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/341
2018-10-18 12:58:55 +01:00
Winnie Hellmann 76b0c82706 Adjust link to docs development guide 2018-10-15 11:01:43 +00:00
Marcel Amirault 5849a0ceba Docs: Fixing some bad links 2018-10-14 22:55:12 +00:00
Evan Read 2139df1bfb Fix links that 404 and style changes
- Some links internal links were incorrect.
- Removed some #overview anchor links, because they don't
  jump much content.
- Made text confirm to suggested proselint and mardownlint rules.
2018-10-09 09:43:14 +10:00
Evan Read 5e583dc62f Add linting section to documentation guidelines 2018-09-26 12:47:56 +10:00
Evan Read d68ee3cea8 Add clarity to EE feature styles for features introduced before and after 9.2 2018-09-25 11:38:51 +00:00
Marcia Ramos 9b53925481 Explain the docs' CD, relating to the milestone the doc is set to vs online docs 2018-09-20 07:13:30 +00:00
Casey Burnett f3507cbf70 docs/ Grammatical Fix workflow.md 2018-09-14 11:08:31 +00:00
Mike Lewis 79322c3c93 Merge branch 'docs/dangerfile' into 'master'
Add Documentation Dangerfile

See merge request gitlab-org/gitlab-ce!21395
2018-09-07 21:18:36 +00:00
Mike Lewis 15c87796ec Merge branch 'use-colon-in-lists' into 'master'
Add guidance on using colons in bullet lists, and make styleguide adhere closer to styleguide.

Closes #51086

See merge request gitlab-org/gitlab-ce!21549
2018-09-07 21:05:20 +00:00
Brett Walker b0be58a1b3 Resolve "CE documentation is not CommonMark compliant" 2018-09-06 16:52:18 +00:00
Achilleas Pipinellis b1b55371c6
Add Documentation Dangerfile
Every time a doc change is made, a comment to
ping the @gl-docsteam is added.
2018-09-06 10:50:35 +02:00
Evan Read 07554a1d4b Add guidance on using colons in bullet lists, and make styleguide adhere closer to styleguide. 2018-09-06 10:54:02 +10:00
Achilleas Pipinellis 8dbcd11075
Compress all PNG images under doc/
The pngquant tool was used https://pngquant.org, and particularly, the
following command:

        /usr/bin/pngquant -f --skip-if-larger --ext .png --speed 1 image.png

Before: 47584K
After : 34924K
2018-08-27 15:52:03 +02:00
Marcia Ramos 819f6d9bce Documentation process at GitLab 2018-08-16 09:30:04 +00:00
Achilleas Pipinellis 9982ff3f99
Prefer using direct links in docs styleguide 2018-07-25 09:26:47 +02:00
Achilleas Pipinellis e0af4c1982
Document how the new automatic review apps for docs work
This was missed from
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20130
2018-06-25 16:35:25 +02:00
Marcia Ramos c4b185fb5a clarify what "methods" are 2018-06-20 14:13:03 +01:00
Marcia Ramos 25f90286f2 Update styleguide.md with rules for navigation items 2018-06-20 09:48:34 +00:00
Mark Chao d5a303cf4d Doc update 2018-06-06 21:01:43 +09:00
Marcia Ramos cc9928c256 Docs: add the documentation guidelines into its own dir 2018-06-06 11:32:38 +00:00