Commit Graph

70 Commits

Author SHA1 Message Date
Marcel Amirault 1e2f46f864 Fix capitalization in more docs
Fix capitalization in docs for works like GitLab, Git
Omnibus, etc
2019-08-29 08:50:59 +00:00
Stan Hu c2541b6409 Upgrade Mermaid to v8.2.4
This fixes a regression that does not permit spaces in subgraph titles.

Full details: https://github.com/knsv/mermaid/releases
2019-08-25 13:19:12 -07:00
Marcel Amirault d2cb8f785e Update docs to pass new markdownlint
Deletes extra spaces and line, makes lists consistent, and
fixes links.
2019-08-22 08:50:31 +00:00
Tristan Read d6d75da930 Embed metrics charts in issues - docs 2019-08-14 05:14:49 +00:00
Stan Hu 8f9b2fcc64 Document required quotes in Mermaid subgraph titles
Mermaid v8.2.3 added support for styling in subgraphs, but if there are
multiple words in a title, quotes are required.

* https://github.com/knsv/mermaid/pull/845
* https://github.com/knsv/mermaid/issues/391#issuecomment-495602059

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/65338
2019-07-31 07:09:08 -07:00
Eric Lindsey 461418e1e8 Fix rendering in Newline section 2019-07-25 03:08:43 +00:00
Marcel Amirault 4da0aa973f Add whitespace back to markdown doc 2019-07-24 23:33:19 +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
Christopher Amurao c5bbbde1f3 Update markdown.md to remove typo, "test" was left in the documentation 2019-07-15 17:42:06 +00:00
Marcel Amirault 74a8d30090 Fix whitespace in user, and misc, 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
woll render as being in a code block too, even if not
meant to. This fixes all these issues, and cleans up
minor whitespace issues in /user, /security, /ssh
and /migrate_ci_to_ce docs.
2019-07-15 03:02:30 +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
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 1464b1e000 Fix markdown to reduce number of kramdown warnings
Add backticks around square brackets, or fix links, as necessary.
2019-07-03 07:12:04 +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
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
Marcel Amirault ee1838851b Fix broken link in markdown doc 2019-06-27 01:41:05 +00:00
Marcel Amirault e1c6f4334f Markdown doc refactor - squashed
Change emoji to Gitlab rendering and fix typo

Use built in renderer for math

Touchups to GFM Doc and bring in suggestions from MR 22122

Fix link

Add epics to align docs

Add epic badge

Fix dashes making accidental headers, and move wikis down, add emoji note

Add section explaining GitLab markdown extensions

Update to incorporate recent changes

Add links rendering, fix issue rendering as color chip

Add links rendering, fix issue rendering as color chip

Update links to GitLab rendered version of markdown doc

Separate GFM extensions, reorder list, other tweaks

Update code blocks and highlighting

Trying to fix improper markdown rendering

Fix rendering broken by triple backticks and add emoji note

testing triple tildes instead of quad backticks

testing rending after mermaid

Various fixes to improve markdown rendering

Update markdown doc after review

Fix markdown doc after review, part two

fix typo in markdown doc
2019-06-27 00:28:39 +00:00
Mark Lapierre bb3280f1cb Replace rendered example with image
Because the markdown wouldn't have been rendered
on docs.gitlab.com
2019-06-11 16:14:00 +00:00
Marcel Amirault b8c3339a46 Docs: Clean up links to remove ./ usage 2019-06-05 10:10:28 +00:00
Paul Gascou-Vaillancourt 1b3c419355 Fix emojis URLs 2019-05-17 00:23:09 +00:00
Evan Read 503a861e86 Use real mermaid for mermaid result 2019-05-14 00:42:23 +00:00
Marcel Amirault 113da4577b Docs: Merge EE doc/​user to CE 2019-05-05 13:07:20 +00:00
Marcel Amirault 8154581975 Docs: Add examples for linking to header IDs 2019-04-09 10:56:36 +00:00
Evan Read be0512243f Fix display of emoji in GFM docs 2019-03-26 17:26:32 +00:00
David Coy bb3ed72d11 Fix Emoji URLs 2019-03-25 05:05:29 +00:00
Evan Read 47fb1c5235 Remove consecutive blank lines from markdown files
For the sake of consistency, removes any extraneous
consecutive blank lines from the doc suite.
2019-02-18 09:36:13 +00:00
Jan Provaznik b2c70230b3 Remove Redcarpet markdown engine
This engine was replaced with CommonMarker in 11.4, it was deprecated
since then.
2019-02-04 12:48:35 +01:00
Stefan Schmalzhaf b1df1a1759 emoji cheat sheet with shortcodes (#42672) 2019-01-11 10:37:04 +00:00
Achilleas Pipinellis 91192264e1 Add docs for frontmatter delimiters 2018-12-18 03:43:34 +00:00
Lorenz Schmid aa4ebe7f28 Updated Katex "Supported Functions" link 2018-11-26 08:29:49 +00:00
Marcia Ramos 3cfdb0acb2 Docs: updates docs development guidelines 2018-11-12 13:30:41 +00:00
luci 4299f2b13c Little typo in markdown.md 2018-11-06 21:40:14 +00:00
Marcia Ramos e75d5b7020 Docs: update GFM guide 2018-10-31 17:09:18 +00:00
smit_tooned 67a605807d docs/Tsumitsu Fix render issue in GFM documentation page 2018-10-09 10:59:58 +00:00
Brett Walker b0be58a1b3 Resolve "CE documentation is not CommonMark compliant" 2018-09-06 16:52:18 +00:00
Brett Walker dc44b0083c Update user markdown documentation for CommonMark 2018-09-06 08:23:42 +00:00
Alexander Popov 95644413e5
Add note about Noto Color Emoji font support by default
In modern Linux distros.

Source: https://www.omgubuntu.co.uk/2018/06/use-emoji-linux-ubuntu-apps
2018-08-16 23:04:48 +03:00
Clement Ho fcee676ca1 Merge branch 'add_google_noto_color_emoji_font' into 'master'
Add Noto Color Emoji font support

See merge request gitlab-org/gitlab-ce!19036
2018-08-13 19:22:16 +00:00
Alexander Popov f73a21e357
Add Noto Color Emoji font support
This is a font from [Google](https://www.google.com/get/noto/).

Arch Linux [has a recommendation of it](https://wiki.archlinux.org/index.php/fonts#Emoji_and_symbols).

Add info about this into `docs/user/markdown.md#emoji`
2018-08-13 21:11:40 +03:00
Sean McGivern e5c0f495a4 Merge branch '28930-add-project-reference-filter' into 'master'
Resolve "GFM : provide 'project' reference in comment"

Closes #28930

See merge request gitlab-org/gitlab-ce!20285
2018-08-10 11:37:45 +00:00
Brett Walker 7670c29f08 specify that wiki pags are rendered with Redcarpet 2018-07-06 16:45:50 -05:00
Reuben Pereira 3abe12707e Add an entry about project reference linking in the markdown doc. 2018-06-30 16:25:09 +05:30
Brett Walker f79410fe17 enable CommonMark as the default 2018-06-14 08:30:16 +00:00
Edwin Torres 3ef1726ddb fixed typos, added text for clarifiction; markdown.md 2018-06-07 16:09:50 -04:00
Jonathan Duck 7de3164160 Replace whitespace demonstrating line-breaks in GFM docs 2018-02-28 16:43:05 +00:00
Ulf Rompe 54955c4f18 Format markdown.md to comply with what it describes.
When the text says "here are two spaces to force a line break"
there really should be two spaces to force a line break.
2018-02-22 06:32:10 +00:00
Norike Abe 835e0227d8 emoji.codes is now emojicopy.com 2018-02-19 11:21:48 +00:00
Tony Rom d90d141c24 Add Colors to GitLab Flavored Markdown 2018-01-29 17:39:19 +03:00
Dimitrie Hoekstra 7c20829c40 clearer-documentation-on-inline-diffs 2017-12-14 18:14:23 +00:00
Achilleas Pipinellis 82da87f5fb
Add version mermaid support was introduced 2017-12-01 18:20:44 +01:00