Skip to content

contribute tweaks #15859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 12, 2022
Merged

contribute tweaks #15859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _data/toc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1811,7 +1811,7 @@ contribute:
- path: /contribute/components/badges/
title: Badges
- path: /contribute/components/call-outs/
title: Call outs
title: Callouts
- path: /contribute/components/cards/
title: Cards
- path: /contribute/components/code-blocks/
Expand Down
22 changes: 11 additions & 11 deletions contribute/components/call-outs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
description: components and formatting examples used in Docker's docs
title: Call outs
title: Callouts
toc_max: 3
---

We support these broad categories of call outs:
We support these broad categories of callouts:

- Notes (no Liquid tag required)
- Important, which use the `{: .important}` tag
Expand Down Expand Up @@ -37,21 +37,21 @@ We support these broad categories of call outs:
> `docker-compose down`. If you want to remove the volumes, you will need to add
> the `--volumes` flag.
>
> The Docker Dashboard does _not_ remove volumes when you delete the app stack.
> The Docker Dashboard does not remove volumes when you delete the app stack.
{: .warning}

## HTML

```html
> **Note**
>
> Note the way the `get_hit_count` function is written. This basic retry
> loop lets us attempt our request multiple times if the redis service is
> not available. This is useful at startup while the application comes
> online, but also makes our application more resilient if the Redis
> service needs to be restarted anytime during the app's lifetime. In a
> cluster, this also helps handling momentary connection drops between
> nodes.
>
> Note the way the `get_hit_count` function is written. This basic retry
> loop lets us attempt our request multiple times if the redis service is
> not available. This is useful at startup while the application comes
> online, but also makes our application more resilient if the Redis
> service needs to be restarted anytime during the app's lifetime. In a
> cluster, this also helps handling momentary connection drops between
> nodes.

> **Important**
>
Expand Down
6 changes: 3 additions & 3 deletions contribute/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ as possible for you to work in this repository. The following sections guide you
<div class="component-icon">
<img src="/assets/images/menu-book.svg" alt="Docker Desktop for Mac" width="45" height="45">
</div>
<h2 id="docker-for-mac"><a href="/contribute/style/grammar/">Grammar guide</a></h2>
<p>Explore Docker's grammar guide.</p>
<h2 id="docker-for-mac"><a href="/contribute/style/grammar/">Grammar and style</a></h2>
<p>Explore Docker's grammar and style guide.</p>
</div>
</div>
<div class="col-xs-12 col-sm-12 col-md-12 col-lg-4 block">
<div class="component">
<div class="component-icon">
<img src="/assets/images/newspaper.svg" alt="Docker for Linux" width="45" height="45">
</div>
<h2 id="docker-for-linux"><a href="/contribute/style/formatting/">Formatting guidelines</a></h2>
<h2 id="docker-for-linux"><a href="/contribute/style/formatting/">Formatting</a></h2>
<p>Format your content to match the rest of our documentation.</p>
</div>
</div>
Expand Down