Commit Graph

169 Commits

Author SHA1 Message Date
GitLab Bot 9c83aadd26 Add latest changes from gitlab-org/gitlab@master 2020-03-25 06:07:58 +00:00
GitLab Bot 23bc19cb73 Add latest changes from gitlab-org/gitlab@master 2020-03-25 00:08:11 +00:00
GitLab Bot 603c7d4cac Add latest changes from gitlab-org/gitlab@master 2020-03-24 18:07:55 +00:00
GitLab Bot be2f4c5788 Add latest changes from gitlab-org/gitlab@master 2020-03-24 03:09:28 +00:00
GitLab Bot 5b51129e33 Add latest changes from gitlab-org/gitlab@master 2020-03-23 03:09:21 +00:00
GitLab Bot 9345f69894 Add latest changes from gitlab-org/gitlab@master 2020-03-17 03:09:27 +00:00
GitLab Bot 18f7828977 Add latest changes from gitlab-org/gitlab@master 2020-03-12 09:09:55 +00:00
GitLab Bot 8191b1571c Add latest changes from gitlab-org/gitlab@master 2020-03-12 06:09:35 +00:00
GitLab Bot c9687bdf58 Add latest changes from gitlab-org/gitlab@master 2020-03-11 12:09:26 +00:00
GitLab Bot a325f3a104 Add latest changes from gitlab-org/gitlab@master 2020-03-02 09:07:59 +00:00
GitLab Bot b98fa9ef3d Add latest changes from gitlab-org/gitlab@master 2020-02-25 09:09:10 +00:00
GitLab Bot c77e16429b Add latest changes from gitlab-org/gitlab@master 2020-02-23 09:08:46 +00:00
GitLab Bot 6b8d671de7 Add latest changes from gitlab-org/gitlab@master 2020-02-18 18:09:07 +00:00
GitLab Bot 7351a484d7 Add latest changes from gitlab-org/gitlab@master 2020-02-10 12:08:59 +00:00
GitLab Bot 0eb3d2f799 Add latest changes from gitlab-org/gitlab@master 2020-02-06 15:09:11 +00:00
GitLab Bot 0434f38ef1 Add latest changes from gitlab-org/gitlab@master 2020-01-31 18:09:11 +00:00
GitLab Bot c27acb1d37 Add latest changes from gitlab-org/gitlab@master 2020-01-31 15:08:42 +00:00
GitLab Bot 536aa3a1f4 Add latest changes from gitlab-org/gitlab@master 2020-01-30 15:09:15 +00:00
GitLab Bot 50ae406553 Add latest changes from gitlab-org/gitlab@master 2020-01-30 12:08:54 +00:00
GitLab Bot db24ab2b72 Add latest changes from gitlab-org/gitlab@master 2020-01-28 12:08:44 +00:00
GitLab Bot 1ce6af4aad Add latest changes from gitlab-org/gitlab@master 2020-01-24 00:08:51 +00:00
GitLab Bot ccaa944882 Add latest changes from gitlab-org/gitlab@master 2020-01-23 03:08:53 +00:00
GitLab Bot afe057a8ff Add latest changes from gitlab-org/gitlab@master 2020-01-21 09:08:43 +00:00
GitLab Bot e0ab7eda1b Add latest changes from gitlab-org/gitlab@master 2020-01-20 18:08:44 +00:00
GitLab Bot aa0f0e9921 Add latest changes from gitlab-org/gitlab@master 2020-01-16 18:08:46 +00:00
GitLab Bot 9caed104bc Add latest changes from gitlab-org/gitlab@master 2019-12-11 03:07:31 +00:00
GitLab Bot e2334f3613 Add latest changes from gitlab-org/gitlab@master 2019-12-04 00:06:15 +00:00
GitLab Bot bffcdf9bca Add latest changes from gitlab-org/gitlab@master 2019-12-02 12:06:45 +00:00
GitLab Bot 688e33953d Add latest changes from gitlab-org/gitlab@master 2019-11-27 06:06:40 +00:00
GitLab Bot d5b4360051 Add latest changes from gitlab-org/gitlab@master 2019-11-26 03:06:24 +00:00
GitLab Bot 6e81d7f628 Add latest changes from gitlab-org/gitlab@master 2019-11-15 15:06:12 +00:00
GitLab Bot 3318518149 Add latest changes from gitlab-org/gitlab@master 2019-11-13 15:07:29 +00:00
GitLab Bot 9bbb32b297 Add latest changes from gitlab-org/gitlab@master 2019-10-18 06:07:02 +00:00
GitLab Bot 8e45d25f7d Add latest changes from gitlab-org/gitlab@master 2019-10-16 18:08:01 +00:00
GitLab Bot 565fa11a26 Add latest changes from gitlab-org/gitlab@master 2019-10-14 21:06:30 +00:00
GitLab Bot eccfaf7c24 Add latest changes from gitlab-org/gitlab@master 2019-10-14 06:06:06 +00:00
GitLab Bot 934c2d5cf0 Add latest changes from gitlab-org/gitlab@master 2019-10-14 03:06:12 +00:00
GitLab Bot b4e072cbaf Add latest changes from gitlab-org/gitlab@master 2019-10-11 06:06:27 +00:00
GitLab Bot 94611567bd Add latest changes from gitlab-org/gitlab@master 2019-09-30 09:06:31 +00:00
GitLab Bot 45482d5a27 Add latest changes from gitlab-org/gitlab@master 2019-09-27 12:06:07 +00:00
GitLab Bot fbcb36880c Add latest changes from gitlab-org/gitlab@master 2019-09-25 06:06:16 +00:00
GitLab Bot 89861e72b7 Add latest changes from gitlab-org/gitlab@master 2019-09-23 06:06:19 +00:00
GitLab Bot 6cd5b7dbfa Add latest changes from gitlab-org/gitlab@master 2019-09-19 11:50:12 +00:00
GitLab Bot 80f61b4035 Add latest changes from gitlab-org/gitlab@master 2019-09-18 14:02:45 +00:00
Mike Lewis 88d66248d0 Edits to Lists section of Documentation Style Guide 2019-09-10 07:35:40 +00:00
Paulo Ribeiro 06d4c54119 Correct typo in documentation 2019-09-09 12:51:41 +00:00
Marcel Amirault 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
Evan Read 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
Achilleas Pipinellis 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
Marcel Amirault 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
Marcel Amirault 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
Achilleas Pipinellis 1ac21f7ae6
Add missing (FREE ONLY) docs tier badge 2019-08-13 10:49:06 +03:00
Marcel Amirault 15f9862bb9 Update list information in docs styleguide
Explain indentation more carefully, and expand examples
2019-08-13 00:57:36 +00:00
David Kartuzinski 49b598b631 Update styleguide.md - just a little typo. 2019-08-12 14:46:06 +00:00
Marcel Amirault 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
Marcel Amirault 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
Marcel Amirault d0a60a7525 Add info about mdl to documentation 2019-07-22 06:03:12 +00:00
Marcel Amirault 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
Achilleas Pipinellis 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
Markus Koller 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
Marcel Amirault 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
Marcel Amirault 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
Evan Read 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
Mike Lewis 1af71196c0 Update styleguide.md to add Notes usage guidelines 2019-07-01 04:28:18 +00:00
Marcel Amirault 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
Marcia Ramos 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
Marcia Ramos a62d93f909 Docs: require release version in image filenames 2019-06-26 14:07:01 +00:00
Evan Read e128239340 Add Markdown linting
Also adds and one linting rule
and makes project conform to it.
2019-06-25 04:34:55 +00:00
Evan Read ef95359362 Https many links in docs 2019-06-18 12:23:07 +00:00
Evan Read c15adde954 Final review feedback applied 2019-05-02 09:55:41 +10:00
Evan Read f7be93a871 Adjust guidance based on feedback 2019-05-02 09:49:52 +10:00
Evan Read 5d4c926d22 Change the guidance for version text 2019-05-02 09:49:52 +10:00
Evan Read f185e4bf9e Adjust how we do version text in docs 2019-05-02 09:49:52 +10:00
Evan Read c135061ff9 Avoid links requiring permissions 2019-04-29 09:33:08 +00:00
Evan Read 0ffb155994 Add whitespace for list so it renders 2019-04-23 12:06:56 +00:00
Achilleas Pipinellis 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
Mike Lewis 4fb50b53ce Fix anchor links 2019-04-17 21:55:50 +00:00
Mike Lewis 8b8fdad788 Fix capitalization of term 2019-04-17 21:37:54 +00:00
Mike Lewis d6d823c900 Reduce duplicate language by linking to a SSOT 2019-04-17 21:28:39 +00:00
Mike Lewis 7d9476dc16 Initial content edits 2019-04-17 21:17:39 +00:00
Sid Sijbrandij ab52ff2e92 ssot as principle 2019-04-16 19:25:48 +00:00
Mike Lewis 5051f5b3d6 Development docs: move some docs content from Handbook and improve content/headings 2019-04-16 05:17:36 +00:00
Mike Lewis 92f0163bc7 Edits to documentation dev doc index 2019-04-08 17:37:45 +00:00
Mike Lewis 64ad62bd91 Improvements to Documentation style and structure information 2019-04-08 17:01:49 +00:00
Evan Read 1cfe83ea5e Change line length recommendation 2019-03-14 10:57:40 +00:00
Marcel Amirault 9c8dc7ddf6 Docs: Fix broken anchors in development docs 2019-03-05 13:06:32 +00:00
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