docs: consolidate glossary pages #1374

ChisomUma · 2025-10-27T03:40:34Z

Proposed changes

Consolidated glossary page in a single .md file. The main challenge was figuring out where the new md file will live. I resolved to create a new top-level .md file that was referenced as a card in the main docs landing page. Attached image below:

Fixed Markdown rendering issue in F5 NGINX One Console glossary page.
Referenced F5 glossary in the NGINX in the new glossary page.

I have a question:

With this new page, should the previous siloed glossaries be removed and referenced to the new page? I left those.

Checklist

Before sharing this pull request, I completed the following checklist:

I read the Contributing guidelines
My branch adheres to the Git conventions
My content changes adhere to the F5 NGINX Documentation style guide
If my changes involve potentially sensitive information¹, I have assessed the possible impact
I have waited to ensure my changes pass tests, and addressed any discovered issues

Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩

ChisomUma · 2025-10-27T03:46:47Z

Hi @mjang i have the PR to issue #602 ready for your review. This was a bit challenging 😄, so I look forward to the reviews and feedback.

mjang · 2025-10-27T13:28:18Z

@ChisomUma FYI, I've submitted this internally for discussion / comment

mjang · 2025-10-27T13:28:50Z

Sorry, accidentally hit the "Close" button. Reopened :)

travisamartin · 2025-10-27T14:27:38Z

content/glossary/glossary.md

+{{<bootstrap-table "table table-striped table-bordered">}}
+| Term        | Definition |
+|-------------|-------------|
+| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |


NGINX Instance Manager currently calls this feature an Instance Group. We should document both terms as synonyms.

Suggested change

| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |

| **Config Sync Group** / **Instance Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. Also known as an Instance Group in NGINX Instance Manager. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |

travisamartin · 2025-10-27T14:28:16Z

content/glossary/glossary.md

+| **Data Plane** | The data plane is the part of a network architecture that carries user traffic. It handles tasks like forwarding data packets between devices and managing network communication. In the context of NGINX, the data plane is responsible for tasks such as load balancing, caching, and serving web content. |
+| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One, you need to use a data plane key. |
+| **Namespace** | In F5 Distributed Cloud, a namespace groups a tenant’s configuration objects, similar to administrative domains. Every object in a namespace must have a unique name, and each namespace must be unique to its tenant. This setup ensures isolation, preventing cross-referencing of objects between namespaces. You'll see the namespace in the NGINX One Console URL as `/namespaces/<namespace name>/`. To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. |
+| **NGINX Agent**                      | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console.                                      |


The Agent also enables communication with NGINX Instance Manager.

Suggested change

| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. |

| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. NGINX Agent also enables communication with NGINX Instance Manager. |

travisamartin · 2025-10-27T14:28:50Z

content/glossary/glossary.md

+| **Config Sync Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
+| **Control Plane** | The control plane is the part of a network architecture that manages and controls the flow or data or traffic (the Data Plane). It is responsible for system-level tasks such as routing and traffic management. |
+| **Data Plane** | The data plane is the part of a network architecture that carries user traffic. It handles tasks like forwarding data packets between devices and managing network communication. In the context of NGINX, the data plane is responsible for tasks such as load balancing, caching, and serving web content. |
+| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One, you need to use a data plane key. |


Suggested change

| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One, you need to use a data plane key. |

| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One Console, you need to use a data plane key. |

travisamartin · 2025-10-27T14:30:22Z

content/glossary/glossary.md

+{{< include "/nginx-one/alert-labels.md" >}}
+
+
+## Legal notice: Licensing agreements for NGINX products


This section seems out of place. Is it necessary?

I don't know. When I run a git blame in our now archived repo, it shows that you added this info to content/nginx-one/about.md in obsolete PR 594 back in January of 2024.

mjang · 2025-10-27T14:51:52Z

@ChisomUma as you can see from @travisamartin 's comments, you've uncovered some consistency issues between products. Thank you.

Let me know if you need advice on how to address the comments.

ChisomUma · 2025-10-27T22:41:22Z

Hi @mjang thank you!! And yes I’ll need advice on how to address the comments.

mjang · 2025-10-28T13:09:39Z

Hi @mjang thank you!! And yes I’ll need advice on how to address the comments.

I've included my suggestions on the comments that you can address.

ChisomUma · 2025-10-29T07:34:37Z

Hi @mjang thank you!! And yes I’ll need advice on how to address the comments.

I've included my suggestions on the comments that you can address.

Hi @mjang I have addressed the changes and commited them. Thanks alot for the help! :)

mjang

One more suggestion. @travisamartin and I need to resolve the discussion about where to put the legal notice.

content/glossary/glossary.md

mjang · 2025-10-29T13:30:41Z

content/_index.md

+{{<card-section showAsCards="true" title="Glossary">}}
+  {{<card title="F5 NGINX Glossary" titleUrl="/glossary/glossary/" brandIcon="NGINX-product-icon.svg" isLanding="true">}}
+  Glossary of common terms and definitions for all F5 NGINX products.
+  {{</card >}}
+{{</card-section>}}


@travisamartin , I like @ChisomUma 's idea to set this up in a separate card for the NGINX doc index page. But I'm OK if you disagree.

Co-authored-by: Mike Jang <[email protected]>

ChisomUma · 2025-10-29T13:46:30Z

One more suggestion. @travisamartin and I need to resolve the discussion about where to put the legal notice.

Merged commit @mjang

ADubhlaoich

Please convert all of the bootstrap-table shortcodes to just table, and add empty lines before and after every table (separating the shortcode tags).

I recommend setting up our linting tools, because there's a few things here that will be triggered.

We also don't use horizontal lines in content anymore (---).

ChisomUma · 2025-11-07T09:59:37Z

Please convert all of the bootstrap-table shortcodes to just table, and add empty lines before and after every table (separating the shortcode tags).

I recommend setting up our linting tools, because there's a few things here that will be triggered.

We also don't use horizontal lines in content anymore (---).

Hi @ADubhlaoich i have addressed this comment

ADubhlaoich

The files in the PR still have Markdown issues:

Double line breaks
No empty lines at the top and bottom of most tables
No empty lines surrounding all headings

Additionally, on re-review of the content, I noticed two things:

The F5 WAF for NGINX include file is single-use. This means that there is now duplicated content at risk of drift.

The F5 WAF for NGINX page the terms were taken from should be updated to use the same include file, so there is a single source of truth.

Similarly, no include file has been created for the Kubernetes terms, which were copied from the NGINX Ingress Controller content.

Converting the content into an include file and adding it to this new page and the NGINX Ingress Controller page asserts a design pattern of creating a single source of truth for topic-specific terminology which is then embedded in two places.

Merge branch 'main' into consolidate-glossary-pages :wq

…mUma/ngixdocsopensourcecontribution into consolidate-glossary-pages

ChisomUma · 2025-11-07T17:46:36Z

Member

Hi @ADubhlaoich I have made an attempt to fix this, I think i misunderstood the intial comment on spacing and only spaced in between tables. im happy to address any comments/feedback

mjang · 2025-11-07T20:14:33Z

@ChisomUma I want to say, I admire your patience and persistence with all of these comments. Thank you!

ChisomUma requested review from a team as code owners October 27, 2025 03:40

github-actions bot added documentation Improvements or additions to documentation product/nginx-one Issues related to NGINX One Console labels Oct 27, 2025

mjang assigned ChisomUma Oct 27, 2025

mjang closed this Oct 27, 2025

mjang reopened this Oct 27, 2025

travisamartin reviewed Oct 27, 2025

View reviewed changes

ChisomUma added 2 commits October 29, 2025 07:57

docs: consolidate glossary pages

53a429b

edit

4a43b38

ChisomUma force-pushed the consolidate-glossary-pages branch from 77ca3fa to 4a43b38 Compare October 29, 2025 07:12

updated glossary

6391c6b

mjang reviewed Oct 29, 2025

View reviewed changes

content/glossary/glossary.md Outdated Show resolved Hide resolved

mjang reviewed Oct 29, 2025

View reviewed changes

Update content/glossary/glossary.md

48d0b99

Co-authored-by: Mike Jang <[email protected]>

Merge branch 'main' into consolidate-glossary-pages

5e36330

ADubhlaoich requested changes Nov 6, 2025

View reviewed changes

ChisomUma added 2 commits November 7, 2025 10:05

Merge branch 'main' into consolidate-glossary-pages

66ea8c9

update: fixed bootstrap-table shortcodes to just table shortcodes

8691101

update: update table shortcode

f6815e7

ChisomUma requested a review from a team as a code owner November 7, 2025 09:47

github-actions bot added the product/waf Issues related to F5 WAF for NGINX label Nov 7, 2025

update

aa3f97f

Merge branch 'main' into consolidate-glossary-pages

ebd8541

ADubhlaoich requested changes Nov 7, 2025

View reviewed changes

ChisomUma added 3 commits November 7, 2025 18:07

:wq

e9ac4c0

Merge branch 'main' into consolidate-glossary-pages :wq

update linting and markdown issues

1b823b7

Merge branch 'consolidate-glossary-pages' of https://github.com/Chiso…

941d5aa

…mUma/ngixdocsopensourcecontribution into consolidate-glossary-pages

ChisomUma requested a review from a team as a code owner November 7, 2025 17:39

github-actions bot added the product/nic Issues related to NGINX Ingress Controller label Nov 7, 2025

	\| NGINX Agent \| A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. \|
	\| NGINX Agent \| A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. NGINX Agent also enables communication with NGINX Instance Manager. \|

	\| Instance \| An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One, you need to use a data plane key. \|
	\| Instance \| An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One Console, you need to use a data plane key. \|

		{{< include "/nginx-one/alert-labels.md" >}}


		## Legal notice: Licensing agreements for NGINX products

docs: consolidate glossary pages #1374

Are you sure you want to change the base?

docs: consolidate glossary pages #1374

Conversation

ChisomUma commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Checklist

Footnotes

Uh oh!

ChisomUma commented Oct 27, 2025

Uh oh!

mjang commented Oct 27, 2025

Uh oh!

mjang commented Oct 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mjang commented Oct 27, 2025

Uh oh!

ChisomUma commented Oct 27, 2025

Uh oh!

mjang commented Oct 28, 2025

Uh oh!

ChisomUma commented Oct 29, 2025

Uh oh!

mjang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChisomUma commented Oct 29, 2025

Uh oh!

ADubhlaoich left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChisomUma commented Nov 7, 2025

Uh oh!

ADubhlaoich left a comment

Choose a reason for hiding this comment

Uh oh!

ChisomUma commented Nov 7, 2025

Uh oh!

mjang commented Nov 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ChisomUma commented Oct 27, 2025 •

edited

Loading

ADubhlaoich left a comment •

edited

Loading