From 14d90b0cf86eb3156ebfc66083b720f76a747282 Mon Sep 17 00:00:00 2001 From: Andrej Ocenas Date: Thu, 30 Sep 2021 18:59:35 +0200 Subject: [PATCH] Link to contributing docs and fix some image markdown examples (#39726) --- contribute/style-guides/documentation-markdown-guide.md | 6 +++--- docs/README.md | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/contribute/style-guides/documentation-markdown-guide.md b/contribute/style-guides/documentation-markdown-guide.md index b22c1db888b46..6b173450ab2ea 100644 --- a/contribute/style-guides/documentation-markdown-guide.md +++ b/contribute/style-guides/documentation-markdown-guide.md @@ -121,15 +121,15 @@ _Do not_ use image shortcodes at this time. Include images in a document using the following syntax: ``` -![Alt text](link to image, starting with /img/docs/ if it is to an internal image "Title of image in sentence case") +![Alt text](link to image, starting with /static/img/docs/ if it is to an internal image "Title of image in sentence case") ``` > **Note:** Alt text does not appear when the user hovers the mouse over the image, but title text does. **Examples:** -- \!\[Grafana logo](/link/to/grafanalogo/logo.png) -- \!\[Example](/img/docs/folder_name/alert_test_rule.png) +- \!\[Grafana logo](/link/to/grafanalogo/logo.png "Grafana logo") +- \!\[Example](/static/img/docs/folder_name/alert_test_rule.png "Example title") This follows the format of "!", alt text wrapped in "[]" and the link URL wrapped in "()". diff --git a/docs/README.md b/docs/README.md index 793a0eceea2a9..03257e72aa588 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,6 +20,8 @@ If you have the grafana/website repo checked out in the same directory as the gr Edit content in the `sources` directory. +### [Contributing](https://github.com/grafana/grafana/blob/main/contribute/documentation.md) + ### Using `relref` for internal links Use the Hugo shortcode [relref](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) any time you are linking to other internal docs pages.