add hugo theme content and new oss-acknowledgements doc

Author: jputrino

.gitignore

@@ -14,3 +14,10 @@ Thumbs.db
 # Logs #
 ########
 *.log
+
+node_modules/*
+.markdownlint.json
+resources/*
+
+# Local Netlify folder
+.netlify

CHANGELOG.md

@@ -1,5 +1,10 @@
-# Changelog
+# CHANGELOG
 
-## 1.0.0 (Month Date, Year)
+<!--- next entry here -->
 
-Initial release of the NGINX template repository.
+## 0.27.1
+2023-03-13
+
+### Fixes
+
+- try out new CSP settings (e5a60a06434eb618630ddce6c140cb570ab6ef96)

README.md

@@ -1,55 +1,66 @@
-# NGINX Template Repository
+# nginx-hugo-theme
 
-## How do I use this template?
+A documentation theme for F5 NGINX projects using [Hugo](https://gohugo.io/).
 
-**DO NOT FORK** -- this template is meant to be used from the **[`Use this template`](https://github.com/nginxinc/template-repository/generate)** feature.
+## Installation
 
-1. Click on **[`Use this template`](https://github.com/nginxinc/template-repository/generate)**
-2. Give a name to your project
-3. Wait until the first run of CI finishes (Github Actions will process the template and commit to your new repo)
-4. Clone your new project and happy coding!
+1. Add the `nginx-hugo-theme` theme as a module mount to your project's config file:
 
-**NOTE**: **WAIT** until the first CI run on GitHub Actions before cloning your new project.
+    ```toml
+    [module]
+    [[module.imports]]
+    path="github.com/nginxinc/nginx-hugo-theme"
+    ```
 
-## What is included on this template?
+## Usage
 
-This template includes all the scaffolding you need to get started on a standards compliant NGINX repository:
+### Create a new doc
 
-- Standard license for NGINX OSS projects
-- Standard `.gitignore` with minimal defaults
-- Issue and PR templates
-- Contributing guidelines
-- Support guidelines
-- Security guidelines for reporting major vulnerabilities
-- NGINX Code of Conduct
-- README placeholder
-- Changelog placeholder
-- Codeowners placeholder
+Run `hugo new <path/doc-title.md>` to add a new doc.
 
----
+> Using the `hugo new` command adds *all* of our pre-configured frontmatter to the new file.
 
-<!--  DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -- PLACEHOLDER SECTIONS HAVE BEEN INCLUDED FOR YOUR CONVENIENCE -->
+### Build the docs
 
-# nginx_hugo_theme
+- Run `hugo` to build static HTML for your docs.
+- Run `hugo server` to run the Hugo development server, so you can watch your changes as you work.
+  Open `localhost:1313` (`127.0.0.1:1313`) in a browser window to view the docs.  
 
-## Requirements
+### Shortcodes
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam elit turpis, varius et arcu elementum, viverra rhoncus sem. Aliquam nec sodales magna, et egestas enim. Mauris lobortis ultrices euismod. Pellentesque in arcu lacus. Mauris cursus laoreet nulla, ac vehicula est. Vestibulum eu mauris quis lorem consectetur aliquam ac nec quam. Vestibulum commodo pharetra mi, at bibendum neque faucibus ut. Mauris et tortor sed sem consectetur eleifend ut non magna. Praesent feugiat placerat nibh, varius viverra orci bibendum sed. Vestibulum dapibus ex ut pulvinar facilisis. Quisque sodales enim et augue tempor mattis. Suspendisse finibus congue felis, ac blandit ligula. Praesent condimentum ultrices odio quis semper. Nunc ultrices, nibh quis mattis pellentesque, elit nulla bibendum felis, quis dapibus erat turpis ac urna.
+See [Hugo Shortcodes](https://gohugo.io/content-management/shortcodes/) for an overview.
 
-## Getting Started
+This theme contains the following custom shorcodes:
 
-Duis sit amet sapien vel velit ornare vulputate. Nulla rutrum euismod risus ac efficitur. Curabitur in sagittis elit, a semper leo. Suspendisse malesuada aliquam velit, eu suscipit lorem vehicula at. Proin turpis lacus, semper in placerat in, accumsan non ipsum. Cras euismod, elit eget pretium laoreet, tortor nulla finibus tortor, nec hendrerit elit turpis ut eros. Quisque congue nisi id mauris molestie, eu condimentum dolor rutrum. Nullam eleifend elit ac lobortis tristique. Pellentesque nec tellus non mauris aliquet commodo a eu elit. Ut at feugiat metus, at tristique mauris. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae;
+**Callouts**:
 
-## How to Use
+- caution.html
+- important.html
+- note.html
+- see-also.html
+- tip.html
+- warning.html
 
-Maecenas at vehicula justo. Suspendisse posuere elementum elit vel posuere. Etiam quis pulvinar massa. Integer tempor semper risus, vitae maximus eros ullamcorper vitae. In egestas, ex vitae gravida sodales, ipsum dolor varius est, et cursus lorem dui a mi. Morbi faucibus ut nisi id faucibus. Sed quis ullamcorper ex. In et dolor id nunc interdum suscipit.
+**Formatting**:
 
-## Contributing
+- collapse.html - Make a collapsible section.
+- comment.html - Insert a comment that won't be rendered at build time.
+- raw-html.html - Insert raw HTML into a markdown doc.
 
-Please see the [contributing guide](https://github.com/nginxinc/nginx-hugo-theme/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
+**Custom data**:
 
-## License
+- openapi.html - Render an OpenAPI spec using ReDoc.
+- metrics.html - Imports data from a JSON file and presents it in table format.
+
+### Includes
+
+This theme contains a custom shortcode called "includes" that lets you reuse content. 
+To use this shortcode, you must add an "includes" folder to the folder that contains your site content (e.g., `content/includes`).
+
+You can reuse the content of any file in the includes directory using the following shortcode syntax:
+
+```md
+{{< include "filename.md" >}}
+```
 
-[Apache License, Version 2.0](https://github.com/nginxinc/nginx-hugo-theme/blob/main/LICENSE)
 
-&copy; [F5, Inc.](https://www.f5.com/) 2023

_redirects_product

@@ -0,0 +1,2 @@
+/   /docs/   301
+*   /docs/404.html  404

_redirects_web-docs

@@ -0,0 +1,2 @@
+/   /nginx-controller/  301
+*   /nginx-controller/404.html  404

archetypes/api.md

@@ -0,0 +1,17 @@
+---
+title: "API Reference v<version>"
+description: "Represents the state of NGINX Controller's API for v<version>"
+date: 2019-11-15T13:21:02-07:00
+weight: 10
+draft: false
+toc: false
+tags: ["api"]
+categories: []
+doctypes: ["reference"]
+menu: "api"
+version: ["<version>"]
+# Create a new entry in the Jira DOCS Catalog and add the ticket ID (DOCS-<number>) below
+docs: "DOCS-000"
+---
+
+{{< openapi spec="/specs/release-<version>/openapi.yaml" >}}

archetypes/blog.md

@@ -0,0 +1,7 @@
+---
+title: ""
+description: ""
+date: {{ .Date }}
+weight: 20
+draft: false
+---

archetypes/concept.md

@@ -0,0 +1,44 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+# Change draft status to false to publish doc
+draft: true
+# Description
+# Add a short description (150 chars) for the doc. Include keywords for SEO. 
+# The description text appears in search results and at the top of the doc.
+description: ""
+# Assign weights in increments of 100
+weight: 
+toc: true
+tags: [ "docs" ]
+# Create a new entry in the Jira DOCS Catalog and add the ticket ID (DOCS-<number>) below
+docs: "DOCS-000"
+# Taxonomies
+# These are pre-populated with all available terms for your convenience.
+# Remove all terms that do not apply.
+categories: ["installation", "platform management", "load balancing", "api management", "service mesh", "security", "analytics"]
+doctypes: ["concept"]
+journeys: ["researching", "getting started", "using", "renewing", "self service"]
+personas: ["devops", "netops", "secops", "support"]
+versions: []
+authors: []
+---
+ 
+## Overview
+
+Briefly describe the goal of this document, that is, what the user will learn or accomplish by reading what follows.
+
+## Concept 1 - format as a noun phrase
+
+This is where you explain the concept. Provide information that will help the user understand what the element/feature is and how it fits into the overall product.
+
+Organize content in this section with H3 and H4 headings.
+
+## Concept 2 - format as a noun phrase
+
+## Concept 3 - format as a noun phrase
+
+## What's Next
+
+- Provide up to 5 links to related topics (optional).
+- Format as a bulleted list.

archetypes/default.md

@@ -0,0 +1,79 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+# Change draft status to false to publish doc.
+draft: true
+# Description
+# Add a short description (150 chars) for the doc. Include keywords for SEO. 
+# The description text appears in search results and at the top of the doc.
+description: ""
+# Assign weights in increments of 100
+weight: 
+toc: true
+tags: [ "docs" ]
+# Create a new entry in the Jira DOCS Catalog and add the ticket ID (DOCS-<number>) below
+docs: "DOCS-000"
+# Taxonomies
+# These are pre-populated with all available terms for your convenience.
+# Remove all terms that do not apply.
+categories: ["installation", "platform management", "load balancing", "api management", "service mesh", "security", "analytics"]
+doctypes: ["task"]
+journeys: ["researching", "getting started", "using", "renewing", "self service"]
+personas: ["devops", "netops", "secops", "support"]
+versions: []
+authors: []
+
+---
+
+## Overview
+
+Briefly describe the goal of this document, that is, what the user will learn or accomplish by reading what follows.
+
+Introduce and explain any new concepts the user may need to understand before proceeding.
+
+## Before You Begin
+
+To complete the instructions in this guide, you need the following:
+
+1. Provide any prerequisites here.
+2. Format as a numbered or bulleted list as appropriate.
+3. Keep the list entries grammatically parallel.1. Provide any prerequisites here.
+
+## Goal 1 - write as a verb phrase
+
+Add introductory text. Say what the user will be doing.
+
+To do xzy, take the following steps:
+
+1. This is where you provide the steps that the user must take to accomplish the goal.
+
+    ```bash
+    code examples should be nested within the list
+    ```
+
+2. Format as numbered lists.
+
+    {{< note >}}Add notes like this.{{</note>}}
+
+3. If there is only one step, you don't need to format it as a numbered list.
+
+## Goal 2 - write as a verb phrase
+
+## Goal 3  - write as a verb phrase
+
+## Discussion
+
+Use the discussion section to expand on the information presented in the steps above.
+
+This section contains the "why" information.
+
+This information lives at the end of the document so that users who just want to follow the steps don't have to scroll through a wall of explanatory text to find them.
+
+## Verification
+
+Explain how the user can verify the steps completed successfully.
+
+## What's Next
+
+- Provide up to 5 links to related topics (optional).
+- Format as a bulleted list.

archetypes/openapi.md

@@ -0,0 +1,30 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+# Change draft status to false to publish doc
+draft: true
+# Description
+# Add a short description (150 chars) for the doc. Include keywords for SEO. 
+# The description text appears in search results and at the top of the doc.
+description: ""
+# Assign weights in increments of 100
+weight: 
+doctypes: ["reference"]
+toc: true
+tags: [ "api" ]
+menu: api
+layout: api
+# Create a new entry in the Jira DOCS Catalog and add the ticket ID (DOCS-<number>) below
+docs: "DOCS-000"
+# Taxonomies
+# These are pre-populated with all available terms for your convenience.
+# Remove all terms that do not apply.
+categories: ["installation", "platform management", "load balancing", "api management", "service mesh", "security", "analytics"]
+doctypes: ["reference"]
+journeys: ["researching", "getting started", "using"]
+personas: ["devops", "netops", "secops", "support"]
+versions: ["<version>"]
+authors: []
+---
+
+{{< openapi spec="/path/to/openapi.yaml" >}}