Skip to content

Commit b82dfea

Browse files
authored
Merge branch 'main' into ENGDOCS-2405a
2 parents cf48a9c + 9f56d94 commit b82dfea

File tree

110 files changed

+331
-364
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+331
-364
lines changed

assets/css/kapa.css

Lines changed: 0 additions & 19 deletions
This file was deleted.

assets/css/styles.css

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
@import "tailwindcss/components";
99
@import "/assets/css/code";
1010
@import "/assets/css/toc";
11-
@import "/assets/css/kapa";
1211

1312
@import "tailwindcss/utilities";
1413
@import "/assets/css/syntax-light";

content/contribute/components/call-outs.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,25 @@ toc_max: 3
66

77
We support these broad categories of callouts:
88

9-
- Alerts (Note, Tip, Important, Warning, Caution)
10-
- Version callouts
11-
- Experimental, which use the `{{%/* experimental */%}}` shortcode
12-
- Restricted, which use the `{{%/* restricted */%}}` shortcode
9+
- Alerts: Note, Tip, Important, Warning, Caution
1310

14-
The experimental and restricted shortcodes take a title as an argument. The
15-
title is optional, defaults to "Experimental" or "Restricted" respectively, and
16-
is displayed in the callout.
11+
We also support summary bars, which represent a feature's required subscription, version, or Adminstrator role.
12+
To add a summary bar:
13+
14+
Add the feature name to the `/data/summary.yaml` file. Use the following attributes:
15+
16+
| Attribute | Description | Possible values |
17+
|----------------|--------------------------------------------------------|---------------------------------------------------------|
18+
| `subscription` | Notes the subscription required to use the feature | All, Personal, Pro, Team, Business |
19+
| `availability` | Notes what product development stage the feature is in | Experimental, Beta, Early access, GA, Retired |
20+
| `requires` | Notes what minimum version is required for the feature | No specific value, use a string to describe the version and link to relevant release notes |
21+
| `for` | Notes if the feature is intended for IT Administrators | Administrators |
22+
23+
Then, add the `summary-bar` shortcode on the page you want to add the summary bar to. Note, the feature name is case sensitive. The icons that appear in the summary bar are automatically rendered.
1724

1825
## Examples
1926

20-
{{< introduced buildx 0.16.0 >}}
27+
{{< summary-bar feature_name="PKG installer" >}}
2128

2229
> [!NOTE]
2330
>
@@ -54,18 +61,10 @@ is displayed in the callout.
5461
5562
For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them.
5663

57-
{{% experimental title="Beta feature" %}}
58-
The Builds view is currently in Beta. This feature may change or be removed from future releases.
59-
{{% /experimental %}}
60-
61-
{{% restricted %}}
62-
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
63-
{{% /restricted %}}
64-
65-
## Formatting
64+
## Formatting
6665

6766
```go
68-
{{</* introduced buildx 0.10.4 "../../release-notes.md#0104" */>}}
67+
> {{< summary-bar feature_name="PKG installer" >}}
6968
```
7069

7170
```html
@@ -101,14 +100,4 @@ Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
101100
> [!CAUTION]
102101
>
103102
> Here be dragons.
104-
```
105-
106-
```go
107-
{{%/* experimental title="Beta feature" */%}}
108-
The Builds view is currently in Beta. This feature may change or be removed from future releases.
109-
{{%/* /experimental */%}}
110-
111-
{{%/* restricted */%}}
112-
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
113-
{{%/* /restricted */%}}
114-
```
103+
```

content/guides/swarm-deploy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ params:
1313
time: 10 minutes
1414
---
1515

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

1818
## Prerequisites
1919

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

3636
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`:
3737

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

4040
```yaml
4141
version: "3.7"

content/guides/zscaler/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ like this:
8484

8585
```dockerfile
8686
FROM debian:bookworm
87-
COPY zscaler-cert.pem /usr/local/share/ca-certificates/zscaler-cert.pem
87+
COPY zscaler-root-ca.crt /usr/local/share/ca-certificates/zscaler-root-ca.crt
8888
RUN apt-get update && \
8989
apt-get install -y ca-certificates && \
9090
update-ca-certificates
9191
```
9292

93-
Here, `zscaler-cert.pem` is the root certificate, located at the root of the
93+
Here, `zscaler-root-ca.crt` is the root certificate, located at the root of the
9494
build context (often within the application's Git repository).
9595

9696
If you use an artifact repository, you can fetch the certificate directly using
@@ -100,7 +100,7 @@ the content digest of the certificate is correct.
100100
```dockerfile
101101
FROM debian:bookworm
102102
ADD --checksum=sha256:24454f830cdb571e2c4ad15481119c43b3cafd48dd869a9b2945d1036d1dc68d \
103-
https://artifacts.example/certs/zscaler-cert.pem /usr/local/share/ca-certificates/zscaler-cert.pem
103+
https://artifacts.example/certs/zscaler-root-ca.crt /usr/local/share/ca-certificates/zscaler-root-ca.crt
104104
RUN apt-get update && \
105105
apt-get install -y ca-certificates && \
106106
update-ca-certificates
@@ -123,7 +123,7 @@ RUN --mount=target=. cmake -B output/
123123

124124
FROM debian:bookworm-slim AS final
125125
ADD --checksum=sha256:24454f830cdb571e2c4ad15481119c43b3cafd48dd869a9b2945d1036d1dc68d \
126-
https://artifacts.example/certs/zscaler-cert.pem /usr/local/share/ca-certificates/zscaler-cert.pem
126+
https://artifacts.example/certs/zscaler-root-ca.crt /usr/local/share/ca-certificates/zscaler-root-ca.crt
127127
RUN apt-get update && \
128128
apt-get install -y ca-certificates && \
129129
update-ca-certificates

content/manuals/admin/company/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ aliases:
4444

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

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

4949
Learn how to administer a company in the following sections.
5050

content/manuals/admin/company/new-company.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can create a new company in the Docker Admin Console. Before you begin, you
1212
- Be the owner of the organization you want to add to your company
1313
- Have a Docker Business subscription
1414

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

1717
## Create a company
1818

content/manuals/admin/company/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Manage company organizations
88

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

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

1313
## View all organizations
1414

content/manuals/admin/company/owners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ owners for all associated organizations. Unlike organization owners, company
1515
owners don't need to be member of an organization. When company owners aren't a
1616
member in an organization, they don't occupy a seat.
1717

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

2020
## Add a company owner
2121

content/manuals/admin/company/users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can manage users at the company-level in the Docker Admin Console.
1010

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

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

1515
## Manage members on a team
1616

0 commit comments

Comments
 (0)