Skip to content

Commit

Permalink
fix: update include.html for heading error (#21906)
Browse files Browse the repository at this point in the history
## Description
- Problem: Some include shortcodes produce missing H3 ToC headings (ex:
https://docker.slack.com/archives/C039ZM6GH4Z/p1737545677728649)
- Fix: Update to include.html uses Hugo readFile function to fix parsing
errors and updated all include shortcodes using Find and Replace to use
correct syntax: `{{% "include-file" %}}`

## Related issues or tickets
-
[ENGDOCS-2398](https://docker.atlassian.net/browse/ENGDOCS-2398?atlOrigin=eyJpIjoiZGE3OTBmY2ExOTliNDVjY2JlOTc4Y2ViY2MwNDI3NDEiLCJwIjoiaiJ9)

## Reviews
- [ ] Technical review

[ENGDOCS-2398]:
https://docker.atlassian.net/browse/ENGDOCS-2398?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
sarahsanders-docker authored Jan 29, 2025
1 parent 4d82913 commit d083617
Show file tree
Hide file tree
Showing 85 changed files with 129 additions and 130 deletions.
4 changes: 2 additions & 2 deletions content/guides/swarm-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ params:
time: 10 minutes
---

{{< include "swarm-mode.md" >}}
{{% include "swarm-mode.md" %}}

## Prerequisites

Expand All @@ -35,7 +35,7 @@ Swarm never creates individual containers like you did in the previous step of t

Now you can write a simple stack file to run and manage your Todo app, the container `getting-started` image created in [Part 2](02_our_app.md) of the tutorial. Place the following in a file called `bb-stack.yaml`:

{{< include "swarm-compose-compat.md" >}}
{{% include "swarm-compose-compat.md" %}}

```yaml
version: "3.7"
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/company/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ aliases:

{{< summary-bar feature_name="Company" >}}

{{< include "admin-company-overview.md" >}}
{{% include "admin-company-overview.md" %}}

Learn how to administer a company in the following sections.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/company/new-company.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can create a new company in the Docker Admin Console. Before you begin, you
- Be the owner of the organization you want to add to your company
- Have a Docker Business subscription

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

## Create a company

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/company/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Manage company organizations

You can manage the organizations in a company in the Docker Admin Console.

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

## View all organizations

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/company/owners.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ owners for all associated organizations. Unlike organization owners, company
owners don't need to be member of an organization. When company owners aren't a
member in an organization, they don't occupy a seat.

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

## Add a company owner

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/company/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can manage users at the company-level in the Docker Admin Console.

{{% admin-users product="admin" layer="company" %}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

## Manage members on a team

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ grid:
icon: help
---

{{< include "admin-org-overview.md" >}}
{{% include "admin-org-overview.md" %}}

To create an organization, see [Create your organization](../organization/orgs.md).

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/activity-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Owners can also see the activity logs for their repository if the repository is
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

{{% admin-org-audit-log product="admin" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/general-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to manage settings for organizations using Docker Admin C
keywords: organization, settings, Admin Console
---

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

This section describes how to manage organization settings in the Docker Admin Console.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Key benefits include:

## View Insights for organization users

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To access Insights, you must contact your Customer Success Manager to have the
feature enabled. Once the feature is enabled, access Insights using the following
Expand Down
4 changes: 2 additions & 2 deletions content/manuals/admin/organization/manage-a-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The organization owner can also add additional organization owners to help them
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

1. In Admin Console, select your organization.
2. In the **User management** section, select **Teams**.
Expand Down Expand Up @@ -133,7 +133,7 @@ Organization owners can delete a team in Docker Hub or Admin Console. When you r
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

1. In the [Admin Console](https://app.docker.com/admin), select your organization.
2. In the **User management** section, select **Teams**.
Expand Down
12 changes: 6 additions & 6 deletions content/manuals/admin/organization/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Learn how to manage members for your organization in Docker Hub and the Docker A
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

{{% admin-users product="admin" %}}

Expand Down Expand Up @@ -66,7 +66,7 @@ To resend an invitation from Docker Hub:
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To resend an invitation from the Admin Console:

Expand All @@ -93,7 +93,7 @@ To remove a member's invitation from Docker Hub:
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To remove an invitation from the Admin Console:

Expand Down Expand Up @@ -132,7 +132,7 @@ To add a member to a team with Docker Hub:
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To add a member to a team with the Admin Console:

Expand Down Expand Up @@ -164,7 +164,7 @@ To remove a member from a specific team with Docker Hub:
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To remove a member from a specific team with the Admin Console:

Expand Down Expand Up @@ -219,7 +219,7 @@ To export a CSV file of your members:
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To export a CSV file of your members:

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/onboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases:

{{< summary-bar feature_name="Admin orgs" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

Learn how to onboard your organization using Docker Hub or the Docker Admin Console.

Expand Down
4 changes: 2 additions & 2 deletions content/manuals/admin/organization/orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You've now created an organization.
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To create an organization:

Expand Down Expand Up @@ -138,7 +138,7 @@ configure your organization.
{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}
{{% include "admin-early-access.md" %}}

To view an organization in the Admin Console:

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/billing/cycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ When you change the billing cycle's duration:
- The subscription's start date resets. For example, if the start date of the monthly subscription is March 1st and the end date is April 1st, then after switching the billing duration to March 15th, 2024 the new start date is March 15th, 2024, and the new end date is March 15th, 2025.
- Any unused monthly subscription is prorated and applied as credit towards the new annual period. For example, if you switch from a $10 monthly subscription to a $100 annual plan, deducting the unused monthly value (in this case $5), the migration cost becomes $95 ($100 - $5). The renewal cost after March 15, 2025 is $100.

{{< include "tax-compliance.md" >}}
{{% include "tax-compliance.md" %}}

## Personal account

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/billing/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can update the billing information for your personal account or for an organ

The billing information provided appears on all your billing invoices. The email address provided is where Docker sends all invoices and other [billing-related communication](#update-your-billing-invoice-email-address).

{{< include "tax-compliance.md" >}}
{{% include "tax-compliance.md" %}}

## Manage billing information

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/billing/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: payments, billing, subscription, invoices, renewals, invoice managemen

In this section, learn how you can view your billing history, manage your invoices, and verify your renewal date. All monthly and annual subscriptions are automatically renewed at the end of the term using the original form of payment.

{{< include "tax-compliance.md" >}}
{{% include "tax-compliance.md" %}}

## Invoices

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/billing/payment-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following payment methods are supported:

All currency, for example the amount listed on your billing invoice, is in United States dollar (USD).

{{< include "tax-compliance.md" >}}
{{% include "tax-compliance.md" %}}

## Manage payment method

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/billing/tax-certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 50

If you're a customer in the United States and you're exempt from sales tax, you can register a valid tax exemption certificate with Docker's Support team. If you're a global customer subject to VAT, make sure that you provide your [VAT number](/billing/history/#include-your-vat-number-on-your-invoice).

{{< include "tax-compliance.md" >}}
{{% include "tax-compliance.md" %}}

## Prerequisites

Expand Down
10 changes: 5 additions & 5 deletions content/manuals/build/buildkit/dockerfile-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ The following features have graduated from the labs channel to stable:

{{< release-date date="2023-01-10" >}}

{{< include "dockerfile-labs-channel.md" >}}
{{% include "dockerfile-labs-channel.md" %}}

### New

Expand Down Expand Up @@ -371,7 +371,7 @@ The following features have graduated from the labs channel to stable:

{{< release-date date="2021-07-16" >}}

{{< include "dockerfile-labs-channel.md" >}}
{{% include "dockerfile-labs-channel.md" %}}

### New

Expand Down Expand Up @@ -402,7 +402,7 @@ The following features have graduated from the labs channel to stable:

{{< release-date date="2020-12-12" >}}

{{< include "dockerfile-labs-channel.md" >}}
{{% include "dockerfile-labs-channel.md" %}}

### Bug fixes and enhancements

Expand All @@ -423,7 +423,7 @@ The following features have graduated from the labs channel to stable:

{{< release-date date="2020-12-03" >}}

{{< include "dockerfile-labs-channel.md" >}}
{{% include "dockerfile-labs-channel.md" %}}

### Bug fixes and enhancements

Expand Down Expand Up @@ -460,7 +460,7 @@ The following features have graduated from the labs channel to stable:

{{< release-date date="2019-07-31" >}}

{{< include "dockerfile-labs-channel.md" >}}
{{% include "dockerfile-labs-channel.md" %}}

### Bug fixes and enhancements

Expand Down
10 changes: 5 additions & 5 deletions content/manuals/build/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@ The full release note for this release is available

{{< release-date date="2023-03-06" >}}

{{< include "buildx-v0.10-disclaimer.md" >}}
{{% include "buildx-v0.10-disclaimer.md" %}}

### Bug fixes and enhancements

Expand All @@ -660,7 +660,7 @@ The full release note for this release is available

{{< release-date date="2023-02-16" >}}

{{< include "buildx-v0.10-disclaimer.md" >}}
{{% include "buildx-v0.10-disclaimer.md" %}}

### Bug fixes and enhancements

Expand All @@ -674,7 +674,7 @@ The full release note for this release is available

{{< release-date date="2023-01-30" >}}

{{< include "buildx-v0.10-disclaimer.md" >}}
{{% include "buildx-v0.10-disclaimer.md" %}}

### Bug fixes and enhancements

Expand All @@ -688,7 +688,7 @@ The full release note for this release is available

{{< release-date date="2023-01-27" >}}

{{< include "buildx-v0.10-disclaimer.md" >}}
{{% include "buildx-v0.10-disclaimer.md" %}}

### Bug fixes and enhancements

Expand All @@ -705,7 +705,7 @@ The full release note for this release is available

{{< release-date date="2023-01-10" >}}

{{< include "buildx-v0.10-disclaimer.md" >}}
{{% include "buildx-v0.10-disclaimer.md" %}}

### New

Expand Down
4 changes: 2 additions & 2 deletions content/manuals/compose/how-tos/file-watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ aliases:

{{< introduced compose 2.22.0 "/manuals/compose/releases/release-notes.md#2220" >}}

{{< include "compose/watch.md" >}}
{{% include "compose/watch.md" %}}

`watch` adheres to the following file path rules:
* All paths are relative to the project directory
Expand Down Expand Up @@ -187,7 +187,7 @@ This setup demonstrates how to use the `sync+restart` action in Docker Compose t

## Use `watch`

{{< include "compose/configure-watch.md" >}}
{{% include "compose/configure-watch.md" %}}

> [!NOTE]
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:

{{< introduced compose 2.20.3 "/manuals/compose/releases/release-notes.md#2203" >}}

{{< include "compose/include.md" >}}
{{% include "compose/include.md" %}}

The [`include` top-level element](/reference/compose-file/include.md) helps to reflect the engineering team responsible for the code directly in the config file's organization. It also solves the relative path problem that [`extends`](extends.md) and [merge](merge.md) present.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/how-tos/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:
- /compose/networking/
---

{{< include "compose-eol.md" >}}
{{% include "compose-eol.md" %}}

By default Compose sets up a single
[network](/reference/cli/docker/network/create.md) for your app. Each
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/how-tos/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:
- /compose/profiles/
---

{{< include "compose/profiles.md" >}}
{{% include "compose/profiles.md" %}}

## Assigning profiles to services

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/how-tos/use-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:

A secret is any piece of data, such as a password, certificate, or API key, that shouldn’t be transmitted over a network or stored unencrypted in a Dockerfile or in your application’s source code.

{{< include "compose/secrets.md" >}}
{{% include "compose/secrets.md" %}}

Environment variables are often available to all processes, and it can be difficult to track access. They can also be printed in logs when debugging errors without your knowledge. Using secrets mitigates these risks.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:
- /desktop/dev-environments/
---

{{< include "dev-envs-changing.md" >}}
{{% include "dev-envs-changing.md" %}}

{{< summary-bar feature_name="Dev Environments" >}}

Expand Down
Loading

0 comments on commit d083617

Please sign in to comment.