Skip to content

Commit

Permalink
Link to contributing docs and fix some image markdown examples (grafa…
Browse files Browse the repository at this point in the history
  • Loading branch information
aocenas authored Sep 30, 2021
1 parent 2b4e51f commit 14d90b0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 3 additions & 3 deletions contribute/style-guides/documentation-markdown-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 "()".

Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 14d90b0

Please sign in to comment.