Pre OSS commit

Author: nginx

.cloudcannon/postbuild

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+## Find and fix broken images and links caused by how the baseURL is set in the config.yml
+find public -type f -name "*.html" -exec sed -i 's/="\/\//="\//g' {} \;
+
+## Add the CloudCannon 'editable' class to content divs
+find public -type f -name "index.html" -exec sed -i 's/class="content/& editable/g' {} \;

.cloudcannon/prebuild

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+## check the version of the hugo theme currently being used 
+## if it is different from the one defined in the go.mod file
+## then run hugo mod get -u to update the theme
+
+theme_version=$(grep -o 'v[0-9]\+\(\.[0-9]\+\)\{2\}' go.mod)
+
+current_theme_version=$(hugo mod graph | grep -o 'v[0-9]\+\(\.[0-9]\+\)\{2\}')
+
+printf "Theme version in go.mod is: %s \n" "$theme_version"
+
+printf "Theme version in use by Hugo is: %s \n" "$current_theme_version"
+
+
+# if the theme version in go.mod is the same as the one in use by Hugo, run hugo mod clean to clear any outdated theme files from the cache
+# if the theme version in go.mod is different from the one in use by Hugo, update it by running hugo mod get -u
+
+if [ "$theme_version" == "$current_theme_version" ]; then
+    printf "Theme version in go.mod is the same as the one in use by Hugo. Cleaning the cache. \n"
+    hugo mod clean ;
+elif [ "$theme_version" != "$current_theme_version" ]; then
+    printf "Updating theme version to %s \n" "$current_theme_version"
+    hugo mod get -u ;
+# if an error occurs, exit with a non-zero status code
+else
+    printf "An error occurred: unable to retrieve the latest version of the Hugo theme.\n"
+    exit 1
+fi

.cloudcannon/preinstall

@@ -0,0 +1 @@
+install-hugo 0.134.2

.cloudcannon/schemas/concept.md

@@ -0,0 +1,31 @@
+---
+title: 
+# Remove or change to false to turn off the right-hand in-page ToC
+toc: true
+# Add a short description (150 chars or less) 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
+# Lower numbers appear higher in the document list
+weight: 
+tags: [ "docs" ]
+---
+ 
+## 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.

.cloudcannon/schemas/default.md

@@ -0,0 +1,65 @@
+---
+title: 
+# Remove or set to false to turn off the right-hand in-page ToC
+toc: true
+# Add a short description (150 chars or less) 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
+# Lower numbers appear higher in the document list
+weight: 
+tags: [ "docs" ]
+---
+
+## 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.

.cloudcannon/schemas/headless-collection.md

@@ -0,0 +1,3 @@
+---
+headless: true
+---

.cloudcannon/schemas/includes.md

@@ -0,0 +1,3 @@
+---
+docs: ""
+---

.cloudcannon/schemas/nms/policy.md

@@ -0,0 +1,176 @@
+---
+title:
+# Remove or set to false to turn off the right-hand in-page ToC
+toc: true
+# Add a short description (150 chars or less) 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
+# Lower numbers appear higher in the document list
+weight:
+tags: [ "docs" ]
+---
+
+## Overview
+
+<!--
+If your topic is for a global policy, add the following include:
+
+{{< include "acm/how-to/policies-intro" >}}
+
+- OR -
+
+If your topic is for an API GW policy, add this include:
+
+{{< include "acm/how-to/policies-proxy-intro.md" >}}
+
+-->
+
+---
+
+## About XYZ Policy
+
+<!--
+Explain what the policy does and what it can be used for.
+-->
+
+#### Intended Audience
+
+<!--
+Specify the intended audience for this guide, that is, who is responsible for applying and/or configuring the policy? For example, and Infrastructure Administrator.
+-->
+
+---
+
+## Workflow for Applying Policy
+
+<!--
+Add the high-level steps the user must take to apply the policy. For example:
+
+- Create an environment or edit an existing one.
+- Check the advanced settings for the environment to see if the policy has been applied.
+- Edit the policy to make changes for each environment. Save and publish the changes.
+
+-->
+
+---
+
+## Policy Settings
+
+<!-- Update the following table with the policy's params -->
+
+The following table lists the configurable settings and their default values for the policy.
+
+
+{{< bootstrap-table "table table-striped table-bordered" >}}
+
+| Field        | Datatype | Possible Values     | Description                                        | Required | Default               |
+|--------------|----------|---------------------|----------------------------------------------------|----------|-----------------------|
+| `users.id`   | integer  | A unique int >= 1   | Description for value.                             | Yes      | System assigned       |
+| `users.name` | string   | Example: `Jane Doe` | A short description of what the field is used for. | Yes      | Add the default value |
+| `user.age`   | integer  | 1–110               | Description for the value                          | Yes      |                       |
+
+{{< /bootstrap-table >}}
+
+
+---
+
+## Adding XYZ Policy
+
+{{<tabs name="policy-implementation">}}
+
+{{%tab name="API"%}}
+
+{{<see-also>}}{{< include "acm/how-to/access-acm-api.md" >}}{{</see-also>}}
+
+To create an XYZ policy using the REST API, send an HTTP `POST` request to the Add-Endpoint-Name-Here endpoint.
+
+
+{{< bootstrap-table "table table-striped table-bordered" >}}
+
+| Method | Endpoint            |
+|--------|---------------------|
+| `POST` | `/path/to/endpoint` |
+
+{{</bootstrap-table>}}
+
+
+<details open>
+<summary>JSON request</summary>
+
+``` json
+{
+  "users": [
+    {
+      "id": 1,
+      "name": "John Doe",
+      "age": 24
+    },
+    {
+      "id": 2,
+      "name": "Jane Doe",
+      "age": 28
+    }
+  ]
+}
+```
+
+</details>
+
+{{%/tab%}}
+
+{{%tab name="UI"%}}
+
+To create an XYZ policy using the web interface:
+
+1. Go to the FQDN for your NGINX Management Suite host in a web browser and log in. Then, from the Launchpad menu, select **API Connectivity Manager**.
+2. Add other steps here
+3. As a numbered list.
+
+{{%/tab%}}
+
+{{</tabs>}}
+
+---
+
+## Verify the Policy
+
+<!--
+Add verification instructions to confirm that the policy has been correctly implemented and is being enforced.
+-->
+
+Confirm that the policy has been set up and configured correctly by taking these steps:
+
+- Add steps to verify policy was applied successfully to the the management plane.
+
+Confirm the policy is being enforced:
+
+- Add steps to verify policy is being enforced on the data plane. What can users expect to see?
+
+---
+
+## Troubleshooting
+
+<!-- Add troubleshooting steps for issues users might encounter and can self-solve. The purpose of this section is to deflect customer calls to Support. -->
+
+For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< relref "support/contact-support.md" >}}) for assistance.
+
+### Issue 1
+
+Add a description for the issue. Include any error messages users might see.
+
+Resolution/Workaround:
+
+1. Add steps here
+2. As a
+3. numbered list.
+
+### Issue 2
+
+Add a description for the issue. Include any error messages users might see.
+
+Resolution/Workaround:
+
+1. Add steps here
+2. As a
+3. numbered list.

.gitattributes

@@ -0,0 +1,4 @@
+# Set the default behavior for correcting line endings, 
+# in case people don't have core.autocrlf set.
+* text=auto
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,8 +24,8 @@ A clear and concise description of what you expected to happen.
 
 ### Your environment
 
-- Version of this project or specific commit
-<!-- - Version of any relevant project languages -->
+- Version/release of this project or specific commit
+<!-- - Version/release of any relevant project languages -->
 - Target deployment platform
 
 ### Additional context

.github/about.txt

@@ -0,0 +1,16 @@
+# GitHub Configurations
+
+This directory contains settings used by GitHub for Actions, identifying code reviewers, issue and pull request templates, and more.
+
+## Workflows
+
+### check-broken-links
+
+The check-broken-links workflow relies on the following projects:
+
+- https://github.com/BoundfoxStudios/action-hugo-link-check
+- https://github.com/fenneclab/hugo-bin/releases
+
+The hugo-bin project lets you add Hugo as a dependency in your npm package.json file. The action-hugo-link-check Action requires this, as that is how it identifies which version of Hugo to run to build your docs. 
+
+> Note: The release version numbers in the hugo-bin project do not align with the actual Hugo releases. Check the README and versions in the hugo-bin repo to find out which releases correspond to Hugo releases.