934c2d5cf0
Add latest changes from gitlab-org/gitlab@master
2019-10-14 03:06:12 +00:00
b4e072cbaf
Add latest changes from gitlab-org/gitlab@master
2019-10-11 06:06:27 +00:00
94611567bd
Add latest changes from gitlab-org/gitlab@master
2019-09-30 09:06:31 +00:00
45482d5a27
Add latest changes from gitlab-org/gitlab@master
2019-09-27 12:06:07 +00:00
fbcb36880c
Add latest changes from gitlab-org/gitlab@master
2019-09-25 06:06:16 +00:00
89861e72b7
Add latest changes from gitlab-org/gitlab@master
2019-09-23 06:06:19 +00:00
6cd5b7dbfa
Add latest changes from gitlab-org/gitlab@master
2019-09-19 11:50:12 +00:00
80f61b4035
Add latest changes from gitlab-org/gitlab@master
2019-09-18 14:02:45 +00:00
88d66248d0
Edits to Lists section of Documentation Style Guide
2019-09-10 07:35:40 +00:00
06d4c54119
Correct typo in documentation
2019-09-09 12:51:41 +00:00
3af112a822
Adjust markdown linting guidelines
...
Move details of markdownlint mostly to the documentation
index for a SSoT, and link apropriately
2019-09-05 13:56:15 +00:00
5c8545edf1
Merge branch 'docs/unlinking-emails' into 'master'
...
Remove a section for a now fixed bug
See merge request gitlab-org/gitlab-ce!32319
2019-08-28 06:36:58 +00:00
295b1b4d02
Remove a section for a now fixed bug
...
Those guidelines where based on
https://gitlab.com/gitlab-org/gitlab-docs/issues/311 which seems
to be fixed.
2019-08-28 08:10:00 +02:00
d7d218628f
Fix markdown in various docs
...
Clean up issues that may cause the docs-lint
test to fail, such as trailing whitespace, no
EOF newline, blockquotes, etc
2019-08-28 06:06:34 +00:00
afe4d3e5bb
Update docs style for code blocks
...
Clarify rules for code blocks, including spaces
above and below, and to use tilde when code blocks
contain triple backticks
2019-08-16 12:06:00 +00:00
1ac21f7ae6
Add missing (FREE ONLY) docs tier badge
2019-08-13 10:49:06 +03:00
15f9862bb9
Update list information in docs styleguide
...
Explain indentation more carefully, and expand examples
2019-08-13 00:57:36 +00:00
49b598b631
Update styleguide.md - just a little typo.
2019-08-12 14:46:06 +00:00
cc76259e8d
Fix whitespace in ci docs
...
Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
will render as being in a code block too, even if not
meant to. This fixes all these issues for most docs in
/development, and cleans up other whitespace issues too
2019-07-31 08:28:51 +00:00
0f7d8c0421
Update links to relative
...
Following the single docs codebase change, all internal links
should be relative. Also cleans up one table
2019-07-25 22:49:13 +00:00
d0a60a7525
Add info about mdl to documentation
2019-07-22 06:03:12 +00:00
7da80b2d36
Update numbered lists for docs standards
...
Ensure that all numbered lists use only 1. and no other numbers.
Also ensure that numbered lists use proper spacing.
2019-07-19 02:20:32 +00:00
99f2c986b5
Move the gitlab-docs project under gitlab-org
...
Search and replace gitlab-com/gitlab-docs with gitlab-org/gitlab-docs.
For https://gitlab.com/gitlab-com/gitlab-docs/issues/310
2019-07-11 15:24:33 +03:00
385233981a
Centralize config for markdownlint
...
The configuration is currently only specified in CI, by moving it into
`.mdlrc` we get immediate feedback locally in supported editors.
To ensure `mdl` is available it's also added to the `Gemfile`, though
CI will still use the version installed in the `gitlab-docs-lint` image.
2019-07-09 03:01:04 +00:00
73c6477b7e
Changing badges to use parentheses not brackets
...
Previously, we used brackets to denote the tier badges,
but this made Kramdown, the docs site Markdown renderer,
show many warnings when building the site. This is now
fixed by using parentheses instead of square brackets.
This was caused by [PREMIUM] looking like a link to
Kramdown, which couldn't find a URL there.
See:
- https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484
- https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
2019-07-08 08:50:38 +00:00
6feda1df3b
Change absolute links to relative
...
Change assorted absolute links to ce and ee docs
to relative links
2019-07-05 16:25:58 +00:00
d05eebe1dd
Fix most bare URLs in project
...
Linting rule not enabled for now
because tooling produces false
positives.
2019-07-02 08:50:00 +00:00
1af71196c0
Update styleguide.md to add Notes usage guidelines
2019-07-01 04:28:18 +00:00
20654fb9bf
Enforce consistent prefix for bullet lists
...
Adjusts asterisks to hyphens in assorted docs to allow lint rule to pass
2019-07-01 03:36:23 +00:00
bd9a1f0dd0
Address Mike's review
...
- explictly say not to upload videos
- link videos from any YT account
- embed videos from GL's YT account only
2019-06-27 16:48:02 +00:00
a62d93f909
Docs: require release version in image filenames
2019-06-26 14:07:01 +00:00
e128239340
Add Markdown linting
...
Also adds and one linting rule
and makes project conform to it.
2019-06-25 04:34:55 +00:00
ef95359362
Https many links in docs
2019-06-18 12:23:07 +00:00
c15adde954
Final review feedback applied
2019-05-02 09:55:41 +10:00
f7be93a871
Adjust guidance based on feedback
2019-05-02 09:49:52 +10:00
5d4c926d22
Change the guidance for version text
2019-05-02 09:49:52 +10:00
f185e4bf9e
Adjust how we do version text in docs
2019-05-02 09:49:52 +10:00
c135061ff9
Avoid links requiring permissions
2019-04-29 09:33:08 +00:00
0ffb155994
Add whitespace for list so it renders
2019-04-23 12:06:56 +00:00
21600cc7ed
Document how to use GitLab.com only badges
...
Functionality added in
https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/449
2019-04-22 12:11:50 +00:00
4fb50b53ce
Fix anchor links
2019-04-17 21:55:50 +00:00
8b8fdad788
Fix capitalization of term
2019-04-17 21:37:54 +00:00
d6d823c900
Reduce duplicate language by linking to a SSOT
2019-04-17 21:28:39 +00:00
7d9476dc16
Initial content edits
2019-04-17 21:17:39 +00:00
ab52ff2e92
ssot as principle
2019-04-16 19:25:48 +00:00
5051f5b3d6
Development docs: move some docs content from Handbook and improve content/headings
2019-04-16 05:17:36 +00:00
92f0163bc7
Edits to documentation dev doc index
2019-04-08 17:37:45 +00:00
64ad62bd91
Improvements to Documentation style and structure information
2019-04-08 17:01:49 +00:00
1cfe83ea5e
Change line length recommendation
2019-03-14 10:57:40 +00:00
9c8dc7ddf6
Docs: Fix broken anchors in development docs
2019-03-05 13:06:32 +00:00
2ee23bb312
Add confidential issue linking guidance
2019-03-01 19:07:47 +00:00
70c6628076
Fix a typo
2019-02-12 11:36:04 +00:00
7aa251308f
Fixes a typo
2019-01-24 14:19:22 +00:00
0bfd119ee1
Document docs style exceptions
2019-01-24 13:46:51 +00:00
c9f2ccaea1
Promote sections and minor improvements
2019-01-16 11:56:07 +10:00
ca74ba9777
Document four backticks feature in markdown
2019-01-15 13:20:52 +00:00
a45c223606
Fix indentation and markup for Markdown codeblock
2019-01-11 12:48:37 +01:00
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
50f5f3c721
docs: Fix 'Gilab' typo
2019-01-09 06:28:01 +00:00
868d8ec6e7
Fix broken markdown and other lint problems
2019-01-09 10:37:25 +10:00
4671cb7836
Add API topic template
2019-01-07 14:11:39 +10:00
2268ddc7de
Implement some review comments
...
Also:
- Slight restructure.
- Some Markdown improvements.
2019-01-07 14:11:39 +10:00
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
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
0197f8cf80
Added additional items formerly in the doc template
2018-12-31 18:07:11 +00:00
58e4281477
Another addition formerly in the template
2018-12-31 17:42:05 +00:00
bfc67c3ef4
Improvements to Style Guide, bringing it items from template
2018-12-31 17:34:57 +00:00
1ca583ed74
Update Content section
2018-12-31 15:02:34 +00:00
66b127a5f4
Renamed to Documentation Style Guide
2018-12-31 14:37:03 +00:00
10784261e7
Move language about what belongs in docs into Content, other minor improvements
2018-12-31 02:38:58 +00:00
3cfdb0acb2
Docs: updates docs development guidelines
2018-11-12 13:30:41 +00:00
6e2570d2d5
Docs: Update Variable naming
2018-11-11 23:43:25 +00:00
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
5e583dc62f
Add linting section to documentation guidelines
2018-09-26 12:47:56 +10:00
d68ee3cea8
Add clarity to EE feature styles for features introduced before and after 9.2
2018-09-25 11:38:51 +00:00
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
b0be58a1b3
Resolve "CE documentation is not CommonMark compliant"
2018-09-06 16:52:18 +00:00
07554a1d4b
Add guidance on using colons in bullet lists, and make styleguide adhere closer to styleguide.
2018-09-06 10:54:02 +10:00
819f6d9bce
Documentation process at GitLab
2018-08-16 09:30:04 +00:00
9982ff3f99
Prefer using direct links in docs styleguide
2018-07-25 09:26:47 +02:00
c4b185fb5a
clarify what "methods" are
2018-06-20 14:13:03 +01:00
25f90286f2
Update styleguide.md with rules for navigation items
2018-06-20 09:48:34 +00:00
cc9928c256
Docs: add the documentation guidelines into its own dir
2018-06-06 11:32:38 +00:00
GitLab Bot
Mike Lewis
Paulo Ribeiro
Marcel Amirault
Evan Read
Achilleas Pipinellis
David Kartuzinski
Markus Koller
Marcia Ramos
Sid Sijbrandij
Marcel Amirault
k-nakayama-pg
Marcia Ramos
carla
Brett Walker