Skip to content

Commit 1bd2869

Browse files
committed
Chore: Merge branch 'main' into add/coveo-error-msg
2 parents 2b3d2f3 + 23bf136 commit 1bd2869

File tree

12 files changed

+24
-90
lines changed

12 files changed

+24
-90
lines changed

.github/renovate.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
":configMigration",
99
"abandonments:recommended"
1010
],
11+
"commitMessagePrefix": "Chore:",
1112
"commitMessageLowerCase": "never",
1213
"labels": ["dependency"]
1314
}

.github/workflows/nginx-documentation-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212

1313
steps:
1414
- name: Checkout hugo theme
15-
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.7.1
15+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
1616
with:
1717
fetch-depth: 0 # This is required for hugo Lastmod to function properly
1818

exampleSite/content/test-product/call-out/all-callouts.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ This is a plain callout with no title. It has a [link](#plain-callouts) to a hea
1717
This is a plain callout with a title. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<call-out>` with a custom title parameter.
1818
{{</call-out>}}
1919

20-
{{<before-you-begin>}}
21-
This is a plain callout with a default title for its type. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<before-you-begin>`.
22-
{{</before-you-begin>}}
23-
2420
## Side Callouts
2521

2622
Naturally, callouts should contain less text within them than the text it lives next to. We do this for several reasons. Firstly, it looks weird to have a big empty space in the primary content area. Secondly, if you have more text in the callout, then it stops being a callout. I have asked an LLM to lengthen this passage.
@@ -71,24 +67,3 @@ And a final line.
7167
This is a Warning callout with a custom title. There was previously a bug with **bold text** that we should be aware of and continue to check for. This callout was invoked with the `<call-out>` shortcode with the `.warning` class, and a custom title.
7268
{{</call-out>}}
7369

74-
75-
76-
77-
## Old "plain" callouts
78-
The following will not have special styling, but are pre-existing shortcodes.
79-
80-
{{<note>}}
81-
This is `<note>`. In oldframe it should have `note:` in bold, at the start.
82-
{{</note>}}
83-
84-
{{<tip>}}
85-
This is `<tip>`. In oldframe it should have `tip:` in bold, at the start.
86-
{{</tip>}}
87-
88-
{{<before-you-begin>}}
89-
This is `<before-you-begin>`.
90-
{{</before-you-begin>}}
91-
92-
{{<see-also>}}
93-
This is `<see-also>`.
94-
{{</see-also>}}

exampleSite/content/test-product/call-out/call-out-code-lists.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ weight: 200
1010

1111
- **Using an instance's configuration for the group configuration**: If an instance is the first to join a config sync group and the group's configuration hasn't been defined, the instance’s configuration will become the group’s configuration. Any instances added later will automatically inherit this configuration.
1212

13-
{{< note >}} If you add multiple instances to a single config sync group, simultaneously (with automation), follow these steps. Your instances will inherit your desired configuration:
13+
{{< call-out "note" >}} If you add multiple instances to a single config sync group, simultaneously (with automation), follow these steps. Your instances will inherit your desired configuration:
1414

1515
1. Create a config sync group.
1616
1. Add a configuration to the config sync group, so all instances inherit it.
1717
1. Add the instances in a separate operation.
1818

19-
Your instances should synchronize with your desired configuration within 30 seconds. {{< /note >}}
19+
Your instances should synchronize with your desired configuration within 30 seconds. {{< /call-out >}}
2020

2121

2222
## Text with Unordered List in note
2323

2424
- **Using an instance's configuration for the group configuration**: If an instance is the first to join a config sync group and the group's configuration hasn't been defined, the instance’s configuration will become the group’s configuration. Any instances added later will automatically inherit this configuration.
2525

26-
{{< note >}} If you add multiple instances to a single config sync group, simultaneously (with automation), follow these steps. Your instances will inherit your desired configuration:
26+
{{< call-out "note" >}} If you add multiple instances to a single config sync group, simultaneously (with automation), follow these steps. Your instances will inherit your desired configuration:
2727

2828
- Create a config sync group.
2929
- Add a configuration to the config sync group, so all instances inherit it.
3030
- Add the instances in a separate operation.
3131

32-
Your instances should synchronize with your desired configuration within 30 seconds. {{< /note >}}
32+
Your instances should synchronize with your desired configuration within 30 seconds. {{< /call-out >}}
3333

3434

3535
## Callout within list

exampleSite/content/test-product/everything.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@ title: Everything
44
weight: 200
55
---
66

7-
## before-you-begin
8-
9-
{{< before-you-begin >}}
10-
Before you can set users' passwords, ensure you have [created users](#create-users) in NGINX Instance Manager. Once you've created the users, you can use one of the following options to set their passwords.
11-
{{< /before-you-begin >}}
12-
137
## bootstrap-table
148

159
{{<bootstrap-table "table">}}
@@ -60,10 +54,6 @@ This won't render anything.
6054

6155
{{< include "nginx-openid-repo-note.txt" >}}
6256

63-
## see-also
64-
65-
{{< see-also >}}See also!{{< /see-also >}}
66-
6757

6858
## details
6959
<details>
@@ -75,11 +65,11 @@ And this is the content on how to do so.
7565
<details open>
7666
<summary>example dynamic-agent.conf</summary>
7767

78-
{{<note>}}
68+
{{<call-out "note">}}
7969
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
8070

8171
Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
82-
{{</note>}}
72+
{{</call-out>}}
8373

8474
```yaml
8575
# Dynamic configuration file for NGINX Agent.

layouts/partials/callout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<div>
3737
<div class="call-out-type">
3838
{{ partial "lucide" (dict "context" . "icon" $icon) . }}
39-
{{ $title }}
39+
{{ if $title }}{{ $title }}{{ else }}{{ $type }}{{end}}
4040
</div>
4141
<div class="callout-content">
4242
{{- .content | markdownify -}}

layouts/shortcodes/before-you-begin.html

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

layouts/shortcodes/note.html

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

layouts/shortcodes/see-also.html

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

layouts/shortcodes/tip.html

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

0 commit comments

Comments
 (0)