Skip to content

Commit 6c98b9d

Browse files
authored
Merge branch 'main' into unit-catalog-audit
2 parents 503a29a + c6a4ac4 commit 6c98b9d

File tree

51 files changed

+1760
-1205
lines changed

Some content is hidden

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

51 files changed

+1760
-1205
lines changed

.github/labeler.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ product/nginxaas:
7373
- 'content/nginxaas-azure/**'
7474
- 'content/includes/nginxaas-azure/**'
7575

76+
product/nic:
77+
- changed-files:
78+
- any-glob-to-any-file:
79+
- 'content/nic/**'
80+
- 'content/includes/nic/**'
81+
7682
product/nim:
7783
- changed-files:
7884
- any-glob-to-any-file:

.github/workflows/build-push.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
5959
call-docs-build-push:
6060
needs: prod-check-branch
61-
uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@cc69def33942d819719164723b35b5163d838276 # v1.0.9
61+
uses: nginxinc/docs-actions/.github/workflows/docs-build-push.yml@285440f02d9967b62aeb1b7e0b5c2c70d4f950cf # v1.0.10
6262
with:
6363
production_url_path: ""
6464
preview_url_path: "${{ vars.PREVIEW_URL_PATH }}"

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
22
**/.DS_Store
33

4-
# dependencies
4+
# Log files
5+
*.log
56

67
# testing
78
/coverage

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Contributing guidelines
22

3-
The following is a set of guidelines for community contributions to this
4-
project. We really appreciate your desire to contribute!
3+
The following is a set of guidelines for community contributions to this project.
54

6-
If you are an F5 employee, see the following additional guidance [For F5 Employees](./F5-NGINX-team-notes.md).
5+
We really appreciate your desire to contribute!
6+
7+
If you are an F5 employee, see the following additional guidance on [Maintainers etiquette](/documentation/maintainers-etiquette.md).
78

89
## Table of contents
910

@@ -12,8 +13,8 @@ If you are an F5 employee, see the following additional guidance [For F5 Employe
1213
- [Open a Discussion](#open-a-discussion)
1314
- [Submit a Pull Request](#submit-a-pull-request)
1415
- Review our [Git style guide](#git-style-guide)
15-
- Review our Documentation [style guide](./templates/style-guide.md)
16-
- Review our [Contributing guidelines for writers](./CONTRIBUTING_DOCS.md)
16+
- Review the [Writing style guide](/documentation/style-guide.md)
17+
- Review [Managing content with Hugo](/documentation/writing-hugo.md)
1718
- [Issue Lifecycle](#issue-lifecycle)
1819
- [Additional NGINX documentation](#additional-nginx-documentation)
1920
- [F5 Contributor License Agreement (CLA)](#f5-contributor-license-agreement)
@@ -51,6 +52,7 @@ our documentation as described in our [support](./SUPPORT.md) page.
5152
### Git style guide
5253

5354
- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
55+
- We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting.
5456
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
5557
and summarized in the next few points:
5658

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
HUGO?=hugo
22
HUGO_VERSION?=$(shell hugo version 2>/dev/null | awk '{print $$2}' | cut -d '.' -f 2)
3-
HUGO_IMG?=hugomods/hugo:std-go-git-0.134.3
3+
HUGO_IMG?=hugomods/hugo:std-go-git-0.147.8
44

55
THEME_MODULE = github.com/nginxinc/nginx-hugo-theme
66

7-
ifeq ($(shell [ $(HUGO_VERSION) -gt 133 2>/dev/null ] && echo true || echo false), true)
8-
$(info Hugo is available and has a version greater than 133. Proceeding with build.)
7+
ifeq ($(shell [ $(HUGO_VERSION) -gt 146 2>/dev/null ] && echo true || echo false), true)
8+
$(info Hugo is available and has a version greater than 146. Proceeding with build.)
99
else
10-
$(warning Hugo is not available or using a version less than 134. Attempting to use docker. HUGO_VERSION=$(HUGO_VERSION))
10+
$(warning Hugo is not available or using a version less than 147. Attempting to use docker. HUGO_VERSION=$(HUGO_VERSION))
1111
HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG} /src/hugo-entrypoint.sh
1212
ifeq (, $(shell docker version 2> /dev/null))
13-
$(error Hugo (>0.134) or Docker are required to build the local previews.)
13+
$(error Hugo (>0.147) or Docker are required to build the local previews.)
1414
endif
1515
endif
1616

_banners/agent-v3-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
22

33

4-
F5 NGINX One Console does not currently support Agent 3.x. If you are using NGINX One Console in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
4+
F5 NGINX One Console and NGINX Instance Manager (NIM) do not currently support Agent 3.x. If you are using NGINX One Console or NGINX Instance Manager in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
55

66
Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
77

archetypes/landing-page.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# The title is the product name
3+
title:
4+
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>"
5+
url:
6+
# The cascade directive applies its nested parameters down the page tree until overwritten
7+
cascade:
8+
# The logo file is resolved from the theme, in the folder /static/images/icons/
9+
logo:
10+
# The subtitle displays directly underneath the heading of a given page
11+
nd-subtitle:
12+
# Indicates that this is a custom landing page
13+
nd-landing-page: true
14+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
15+
nd-content-type: landing-page
16+
# Intended for internal catalogue and search, case sensitive:
17+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
18+
nd-product:
19+
---
20+
21+
## About
22+
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
23+
[//]: # "Use underscores for _italics_, and double asterisks for **bold**."
24+
[//]: # "Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
25+
26+
[//]: # "This initial section introduces the product to a reader: give a short 1-2 sentence summary of what the product does and its value to the reader."
27+
[//]: # "Name specific functionality it provides: avoid ambiguous descriptions such as 'enables efficiency', focus on what makes it unique."
28+
29+
## Featured content
30+
[//]: # "You can add a maximum of three cards: any extra will not display."
31+
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
32+
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
33+
34+
{{<card-layout>}}
35+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
36+
{{<card title="<some-title>">}}
37+
<!-- Each description should be roughly 10 words or less. -->
38+
{{</card>}}
39+
<!-- The titleURL and icon are both optional -->
40+
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
41+
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
42+
<!-- Each description should be roughly 10 words or less. -->
43+
{{</card>}}
44+
{{</card-section>}}
45+
{{</card-layout>}}
46+
47+
## Other content
48+
49+
[//]: # "You can add any extra content for the page here, such as additional cards, diagrams or text."

0 commit comments

Comments
 (0)