summaryrefslogtreecommitdiff
path: root/doc/development/documentation
Commit message (Collapse)AuthorAgeFilesLines
* Adjust markdown linting guidelinesMarcel Amirault2019-09-052-66/+39
| | | | | Move details of markdownlint mostly to the documentation index for a SSoT, and link apropriately
* Provide guidance on how docs global navigation should be structuredEvan Read2019-09-052-22/+73
|
* Docs james gill contributionMarcel Amirault2019-09-021-26/+23
|
* Merge branch 'patch-78' into 'master'Ray Paik2019-08-291-1/+1
|\ | | | | | | | | Fixed spelling See merge request gitlab-org/gitlab-ce!32432
| * Fixed spellingShan2019-08-291-1/+1
| |
* | Fixed spellingShan2019-08-291-1/+1
|/
* Merge branch 'docs/unlinking-emails' into 'master'Evan Read2019-08-281-9/+0
|\ | | | | | | | | Remove a section for a now fixed bug See merge request gitlab-org/gitlab-ce!32319
| * Remove a section for a now fixed bugAchilleas Pipinellis2019-08-281-9/+0
| | | | | | | | | | | | Those guidelines where based on https://gitlab.com/gitlab-org/gitlab-docs/issues/311 which seems to be fixed.
* | Fix markdown in various docsMarcel Amirault2019-08-281-5/+0
|/ | | | | | Clean up issues that may cause the docs-lint test to fail, such as trailing whitespace, no EOF newline, blockquotes, etc
* Fix link to issue templateAchilleas Pipinellis2019-08-231-1/+1
|
* Update docs style for code blocksMarcel Amirault2019-08-161-10/+12
| | | | | | Clarify rules for code blocks, including spaces above and below, and to use tilde when code blocks contain triple backticks
* Add missing (FREE ONLY) docs tier badgedocs/add-free-tier-badgeAchilleas Pipinellis2019-08-131-1/+2
|
* Update list information in docs styleguideMarcel Amirault2019-08-131-11/+105
| | | | Explain indentation more carefully, and expand examples
* Update styleguide.md - just a little typo.David Kartuzinski2019-08-121-1/+1
|
* Replace redirect_from with disqus_identifier in docsdocs/disqus-identifierAchilleas Pipinellis2019-08-081-3/+3
| | | | | | Let's use disqus_identifier since this is a more descriptive name. We will need redirect_from for another purpose anyway (Nanoc redirects).
* Fix whitespace in ci docsMarcel Amirault2019-07-312-71/+70
| | | | | | | | | 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
* Update links to relativeMarcel Amirault2019-07-251-1/+1
| | | | | Following the single docs codebase change, all internal links should be relative. Also cleans up one table
* Update guidance for EE doc submissionsMarcel Amirault2019-07-251-33/+10
|
* Add info about mdl to documentationMarcel Amirault2019-07-222-18/+41
|
* Update numbered lists for docs standardsMarcel Amirault2019-07-192-8/+8
| | | | | Ensure that all numbered lists use only 1. and no other numbers. Also ensure that numbered lists use proper spacing.
* Fix unordered list spacingMarcel Amirault2019-07-181-15/+15
| | | | | Correct the spacing of unordered markdown lists in docs, to maintain standards of documentation.
* Merge branch 'rename-gitlab-docs-repo' into 'master'Marcia Ramos2019-07-125-20/+20
|\ | | | | | | | | Move the gitlab-docs project under gitlab-org See merge request gitlab-org/gitlab-ce!30620
| * Move the gitlab-docs project under gitlab-orgrename-gitlab-docs-repoAchilleas Pipinellis2019-07-115-20/+20
| | | | | | | | | | Search and replace gitlab-com/gitlab-docs with gitlab-org/gitlab-docs. For https://gitlab.com/gitlab-com/gitlab-docs/issues/310
* | Remove trailing whitespace in docsMarcel Amirault2019-07-121-1/+1
|/ | | | | Remove unneeded trailing whitespace in lines in /development /ci /api and /administration docs.
* Add link to epic for removing /helplink-help-path-epic-in-dev-docsMike Lewis2019-07-101-3/+6
|
* Centralize config for markdownlintMarkus Koller2019-07-091-2/+2
| | | | | | | | 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.
* Changing badges to use parentheses not bracketsMarcel Amirault2019-07-081-15/+15
| | | | | | | | | | | | | | 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
* Change absolute links to relativeMarcel Amirault2019-07-051-1/+1
| | | | | Change assorted absolute links to ce and ee docs to relative links
* Fix most bare URLs in projectEvan Read2019-07-021-3/+3
| | | | | | Linting rule not enabled for now because tooling produces false positives.
* Docs: update global nav documentMarcia Ramos2019-07-021-21/+13
|
* Update styleguide.md to add Notes usage guidelinesMike Lewis2019-07-011-1/+18
|
* Enforce consistent prefix for bullet listsMarcel Amirault2019-07-011-2/+2
| | | | Adjusts asterisks to hyphens in assorted docs to allow lint rule to pass
* Add diagram to site architecture docsEvan Read2019-06-281-5/+37
|
* Address Mike's reviewMarcia Ramos2019-06-271-2/+90
| | | | | | - explictly say not to upload videos - link videos from any YT account - embed videos from GL's YT account only
* Docs: require release version in image filenamesMarcia Ramos2019-06-261-6/+15
|
* Add Markdown lintingEvan Read2019-06-252-6/+6
| | | | | Also adds and one linting rule and makes project conform to it.
* Https many links in docsEvan Read2019-06-182-3/+3
|
* Clarify the process for CE-first documentationMarkus Koller2019-06-051-3/+8
| | | | | | Previously it was unclear if the docs changes should be included in the MR as well, and adding a changelog entry in the CE MR also triggers the ee-specific-lines-check job in CI.
* Use relative URLs in development docsAchilleas Pipinellis2019-05-273-11/+11
| | | | This is part of https://gitlab.com/gitlab-org/gitlab-ce/issues/61945
* Remove doc/README.md from list of pending filesdocs/single-codebase-dev-guidesAchilleas Pipinellis2019-05-171-2/+1
|
* Add info about the single docs codebase effortdocs/single-codebase-infoAchilleas Pipinellis2019-05-081-0/+56
|
* Final review feedback applieddocs/modify-versions-guidanceEvan Read2019-05-021-3/+3
|
* Adjust guidance based on feedbackEvan Read2019-05-021-2/+3
|
* Change the guidance for version textEvan Read2019-05-021-23/+13
|
* Adjust how we do version text in docsEvan Read2019-05-021-6/+23
|
* Avoid links requiring permissionsEvan Read2019-04-291-3/+10
|
* Add whitespace for list so it rendersEvan Read2019-04-231-4/+5
|
* Document how to use GitLab.com only badgesAchilleas Pipinellis2019-04-221-0/+6
| | | | | Functionality added in https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/449
* Fix anchor linksssotMike Lewis2019-04-171-2/+2
|
* Fix capitalization of termMike Lewis2019-04-171-1/+1
|