docs: consolidate glossary pages

[ChisomUma]

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

Footnotes

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

[ChisomUma]

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]

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

[mjang]

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

[travisamartin]

This section seems out of place. Is it necessary?

[mjang]

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.

[travisamartin]

Hmm. I seem to recall a request at N1C GA to add legal verbiage to the About page, but never to a glossary. I suggest scrapping it.

[mjang]

@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]

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

[mjang]

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]

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.

[ChisomUma]

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]

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.

[ChisomUma]

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]

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

[ChisomUma]

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

Thank you very much @mjang :)

[ADubhlaoich]

LGTM now! Added some edit suggestions for minor formatting stuff.

Table cells are inconsistently sized due to their content, but we generally make the separating row the same size as the heading row.

We use spaces in our Hugo shortcodes to match the usage in Hugo documentation.

As best as I can tell, the only remaining thing left in this PR that needs proper resolution is the legal notice stuff: I'm pretty sure we figured out/solved something about this internally, so I will follow up about it to ensure this PR can be merged ASAP.

[ChisomUma]

LGTM now! Added some edit suggestions for minor formatting stuff.

Table cells are inconsistently sized due to their content, but we generally make the separating row the same size as the heading row.

We use spaces in our Hugo shortcodes to match the usage in Hugo documentation.

As best as I can tell, the only remaining thing left in this PR that needs proper resolution is the legal notice stuff: I'm pretty sure we figured out/solved something about this internally, so I will follow up about it to ensure this PR can be merged ASAP.

Hi @ADubhlaoich thank you so much! I have committed the changes you made and taken note of the formatting choices for my next contribution.

[travisamartin]

Scrap the legal notice, and you're good to go! Thanks. :)

[ChisomUma]

Scrap the legal notice, and you're good to go! Thanks. :)

Hi @travisamartin, this has been removed. Thank you :)