Commit Graph

183 Commits

Author SHA1 Message Date
Evan Read 2ee23bb312 Add confidential issue linking guidance 2019-03-01 19:07:47 +00:00
k-nakayama-pg 70c6628076 Fix a typo 2019-02-12 11:36:04 +00:00
Marcia Ramos 7aa251308f Fixes a typo 2019-01-24 14:19:22 +00:00
Marcia Ramos 0bfd119ee1 Document docs style exceptions 2019-01-24 13:46:51 +00:00
Evan Read c9f2ccaea1 Promote sections and minor improvements 2019-01-16 11:56:07 +10:00
Evan Read ca74ba9777 Document four backticks feature in markdown 2019-01-15 13:20:52 +00:00
Achilleas Pipinellis a45c223606
Fix indentation and markup for Markdown codeblock 2019-01-11 12:48:37 +01:00
Achilleas Pipinellis b7b7d014f5 Merge branch 'docs/fix-styleguide' into 'master'
Fix broken markdown and other lint problems

See merge request gitlab-org/gitlab-ce!24208
2019-01-09 09:55:25 +00:00
carla 50f5f3c721 docs: Fix 'Gilab' typo 2019-01-09 06:28:01 +00:00
Evan Read 868d8ec6e7 Fix broken markdown and other lint problems 2019-01-09 10:37:25 +10:00
Evan Read 4671cb7836 Add API topic template 2019-01-07 14:11:39 +10:00
Evan Read 2268ddc7de Implement some review comments
Also:

- Slight restructure.
- Some Markdown improvements.
2019-01-07 14:11:39 +10:00
Evan Read 40aba81218 Add new styleguide sections for verbs
Also fixes spelling, and makes the Markdown style more consistent.
2019-01-07 14:06:55 +10:00
Achilleas Pipinellis 0e078d1a8a
Replace look-alike token with '<your_access_token>'
Replace all '9koXpg98eAheJpvBs5tK' occurrences with
'<your_access_token>' in API docs.
2019-01-04 13:19:27 +01:00
Mike Lewis 0197f8cf80 Added additional items formerly in the doc template 2018-12-31 18:07:11 +00:00
Mike Lewis 58e4281477 Another addition formerly in the template 2018-12-31 17:42:05 +00:00
Mike Lewis bfc67c3ef4 Improvements to Style Guide, bringing it items from template 2018-12-31 17:34:57 +00:00
Mike Lewis 1ca583ed74 Update Content section 2018-12-31 15:02:34 +00:00
Mike Lewis 66b127a5f4 Renamed to Documentation Style Guide 2018-12-31 14:37:03 +00:00
Mike Lewis 10784261e7 Move language about what belongs in docs into Content, other minor improvements 2018-12-31 02:38:58 +00:00
Marcia Ramos 3cfdb0acb2 Docs: updates docs development guidelines 2018-11-12 13:30:41 +00:00
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
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
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
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
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
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
Marcia Ramos cc9928c256 Docs: add the documentation guidelines into its own dir 2018-06-06 11:32:38 +00:00