From da67559a45c43eb7569bca6285a5afce7928f1d3 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Tue, 30 Sep 2025 15:45:45 +0100 Subject: [PATCH] chore: remove cloudcannon files --- .cloudcannon/initial-site-settings.json | 23 - .cloudcannon/postbuild | 7 - .cloudcannon/prebuild | 29 - .cloudcannon/preinstall | 1 - .cloudcannon/schemas/concept.md | 31 - .cloudcannon/schemas/default.md | 65 -- .cloudcannon/schemas/headless-collection.md | 3 - .cloudcannon/schemas/includes.md | 3 - .cloudcannon/schemas/nms/policy.md | 176 ----- .github/labeler.yml | 1 - cloudcannon.config.yml | 814 -------------------- 11 files changed, 1153 deletions(-) delete mode 100644 .cloudcannon/initial-site-settings.json delete mode 100755 .cloudcannon/postbuild delete mode 100755 .cloudcannon/prebuild delete mode 100644 .cloudcannon/preinstall delete mode 100644 .cloudcannon/schemas/concept.md delete mode 100644 .cloudcannon/schemas/default.md delete mode 100644 .cloudcannon/schemas/headless-collection.md delete mode 100644 .cloudcannon/schemas/includes.md delete mode 100644 .cloudcannon/schemas/nms/policy.md delete mode 100644 cloudcannon.config.yml diff --git a/.cloudcannon/initial-site-settings.json b/.cloudcannon/initial-site-settings.json deleted file mode 100644 index ec214b7e0..000000000 --- a/.cloudcannon/initial-site-settings.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "ssg": "hugo", - "mode": "hosted", - "build": { - "install_command": "[ -f package.json ] && npm i", - "build_command": "hugo --destination public --baseURL / --noTimes", - "output_path": "public", - "environment_variables": [ - { - "key": "HUGO_CACHEDIR", - "value": "/usr/local/__site/src/.hugo_cache/" - } - ], - "preserved_paths": "node_modules/,.hugo_cache/,resources/", - "preserve_output": false, - "include_git": true, - "manually_configure_urls": false, - "hugo_version": "0.134.3", - "ruby_version": "2.7.3", - "node_version": "18", - "deno_version": "1.40.2" - } -} diff --git a/.cloudcannon/postbuild b/.cloudcannon/postbuild deleted file mode 100755 index e336d37e0..000000000 --- a/.cloudcannon/postbuild +++ /dev/null @@ -1,7 +0,0 @@ -#!/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' {} \; diff --git a/.cloudcannon/prebuild b/.cloudcannon/prebuild deleted file mode 100755 index cf037d189..000000000 --- a/.cloudcannon/prebuild +++ /dev/null @@ -1,29 +0,0 @@ -#!/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 diff --git a/.cloudcannon/preinstall b/.cloudcannon/preinstall deleted file mode 100644 index ccd94ee41..000000000 --- a/.cloudcannon/preinstall +++ /dev/null @@ -1 +0,0 @@ -install-hugo 0.134.2 diff --git a/.cloudcannon/schemas/concept.md b/.cloudcannon/schemas/concept.md deleted file mode 100644 index 58412247a..000000000 --- a/.cloudcannon/schemas/concept.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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. diff --git a/.cloudcannon/schemas/default.md b/.cloudcannon/schemas/default.md deleted file mode 100644 index 474baab89..000000000 --- a/.cloudcannon/schemas/default.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - - {{< call-out "note" >}}Add notes like this.{{< /call-out >}} - -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. diff --git a/.cloudcannon/schemas/headless-collection.md b/.cloudcannon/schemas/headless-collection.md deleted file mode 100644 index 3d65eaa0f..000000000 --- a/.cloudcannon/schemas/headless-collection.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -headless: true ---- \ No newline at end of file diff --git a/.cloudcannon/schemas/includes.md b/.cloudcannon/schemas/includes.md deleted file mode 100644 index 8b447a2cc..000000000 --- a/.cloudcannon/schemas/includes.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -docs: "" ---- \ No newline at end of file diff --git a/.cloudcannon/schemas/nms/policy.md b/.cloudcannon/schemas/nms/policy.md deleted file mode 100644 index bd2d670c3..000000000 --- a/.cloudcannon/schemas/nms/policy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -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 - - - ---- - -## About XYZ Policy - - - -#### Intended Audience - - - ---- - -## Workflow for Applying Policy - - - ---- - -## Policy Settings - - - -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 - -{{}} - -{{%tab name="API"%}} - -{{< call-out "note" >}}{{< include "acm/how-to/access-acm-api.md" >}}{{< /call-out >}} - -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` | - -{{}} - - -
-JSON request - -``` json -{ - "users": [ - { - "id": 1, - "name": "John Doe", - "age": 24 - }, - { - "id": 2, - "name": "Jane Doe", - "age": 28 - } - ] -} -``` - -
- -{{%/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%}} - -{{}} - ---- - -## Verify the Policy - - - -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 - - - -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]({{< ref "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. diff --git a/.github/labeler.yml b/.github/labeler.yml index 2e8d1f8d7..c8cd64f8b 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -111,7 +111,6 @@ tooling: - any-glob-to-any-file: - 'layouts/**' - '.github/**' - - '.cloudcannon/**' - 'styles/**' - 'layouts/**' - 'config/**' diff --git a/cloudcannon.config.yml b/cloudcannon.config.yml deleted file mode 100644 index 20e3bc41a..000000000 --- a/cloudcannon.config.yml +++ /dev/null @@ -1,814 +0,0 @@ -paths: - collections: content -collections_config: - pages: - parse_branch_index: true - path: / - standalone_pages: - path: content/ - output: true - parse_branch_index: false - filter: - base: strict - include: - - ossc.md - - search.md - - success.md - name: Standalone Website Pages - description: This collection contains standalone website pages like the search landing page. - icon: notes - sort_options: - - key: weight - order: ascending - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: true - disable_add_folder: false - disable_file_actions: false - schemas: {} - nginx_plus: - path: content/nginx - name: NGINX Plus - description: Documentation for NGINX and NGINX Plus. - output: true - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: false - disable_file_actions: false - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - preview: {} - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - concept: - path: .cloudcannon/schemas/concept.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Concept - icon: lightbulb - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - nap_dos: - path: content/nap-dos - output: true - name: F5 DoS for NGINX - description: Documentation for F5 DoS for NGINX - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: false - disable_file_actions: false - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - concept: - path: .cloudcannon/schemas/concept.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Concept - icon: lightbulb - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - nap_waf: - path: content/nap-waf - output: true - name: F5 WAF for NGINX - description: Documentation for F5 WAF for NGINX. - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: false - disable_file_actions: false - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - concept: - path: .cloudcannon/schemas/concept.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Concept - icon: lightbulb - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - nms: - path: content/nms - output: true - name: NGINX Management Suite - description: Documentation for NGINX Management Suite. - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: false - disable_file_actions: false - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - concept: - path: .cloudcannon/schemas/concept.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Concept - icon: lightbulb - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - policy: - path: .cloudcannon/schemas/nms/policy.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: ACM Policy - icon: table_chart - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - controller: - path: content/controller - output: true - name: NGINX Controller - description: Documentation for NGINX Controller. - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: true - disable_file_actions: true - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - modsec_waf: - path: content/modsec-waf - output: true - name: NGINX ModSec WAF - description: Documentation for NGINX ModSec WAF. - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: true - disable_add_folder: true - disable_file_actions: true - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - solution_bundles: - path: content/solutions - output: true - name: NGINX Solution Bundles - description: Instructions for deploying the multi-product solution bundles. - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: false - disable_file_actions: false - schemas: - default: - path: .cloudcannon/schemas/default.md - reorder_inputs: true - hide_extra_inputs: true - remove_empty_inputs: false - remove_extra_inputs: false - name: Task (default) - icon: task - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - includes: - path: content/includes - output: false - name: Content Reuse - description: A collection of files that can be reused in other documents across the website. - filter: - exclude: - - index.md - parse_branch_index: false - icon: notes - preview: - metadata: - - text: - - key: path - icon: folder - _editables: {} - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: false - disable_file_actions: false - schemas: - default: - path: .cloudcannon/schemas/includes.md - name: Includes template - headless-collection: - path: .cloudcannon/schemas/headless-collection.md - name: Index.md template - data: - path: data - output: false - icon: dataset - _editables: {} - _enabled_editors: - - data - - content - _inputs: {} - _select_data: {} - _structures: {} - create: - path: '[relative_base_path]/{directory}/{filename|slugify}.[ext]' - extra_data: {} - _inputs: {} - _select_data: {} - _structures: {} - disable_add: false - disable_add_folder: true - disable_file_actions: true - schemas: {} -collections_config_override: true -collection_groups: - - heading: "Standalone Web Pages" - collections: - - "standalone_pages" - - heading: "Product Docs" - collections: - - "nginx_plus" - - "nap_dos" - - "nap_waf" - - "nms" - - "controller" - - "modsec_waf" - - heading: "Solutions" - collections: - - "solution_bundles" - - heading: "Content Reuse" - collections: - - "includes" -_enabled_editors: - - content -_inputs: {} -_select_data: {} -_structures: {} -_editables: - text: - bold: true - copyformatting: true - italic: true - link: true - redo: true - removeformat: true - strike: true - subscript: true - superscript: true - underline: true - undo: true -data_config: true -timezone: Etc/UTC -commit_templates: - - template_string: '{commit_type}: {message|trim} {breaking_change|if=breaking_change_message}' - _inputs: - commit_type: - type: select - options: - allow_empty: true - values: - - feature - - fix - - refactor - - update - cascade: true - breaking_change_message: - type: text - cascade: true - extra_data: - breaking_change: |- - - ⚠️ {breaking_change_message} -_snippets_imports: - hugo: - exclude: - - hugo_youtube - - hugo_twitter - - hugo_vimeo - - hugo_instagram -_snippets: - important: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Important - subtext: - - key: content_markdown - - Important note in a callout box. - icon: priority_high - definitions: - shortcode_name: important - content_key: content_markdown - named_args: [] - note: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Note - subtext: - - key: content_markdown - - Note in callout box. - icon: edit_note - definitions: - shortcode_name: note - content_key: content_markdown - named_args: [] - see-also: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: See also - subtext: - - key: content_markdown - - See Also note in callout box. - icon: visibility - definitions: - shortcode_name: see-also - content_key: content_markdown - named_args: [] - before-you-begin: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Befor You Begin - subtext: - - key: content_markdown - - Before You Begin note in callout box. - icon: front_hand - definitions: - shortcode_name: before-you-begin - content_key: content_markdown - named_args: [] - deprecated: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Deprecated - subtext: - - key: content_markdown - - Deprecated callout in a box. - icon: delete - definitions: - shortcode_name: deprecated - content_key: content_markdown - named_args: [] - caution: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Caution - subtext: - - key: content_markdown - - Caution callout in a box. - icon: announcement - definitions: - shortcode_name: caution - content_key: content_markdown - named_args: [] - warning: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Warning - subtext: - - key: content_markdown - - Warning callout in a box. - icon: warning - definitions: - shortcode_name: warning - content_key: content_markdown - named_args: [] - call-out: - template: hugo_paired_shortcode_positional_args - inline: false - preview: - text: - - key: callout_title - - Callout - subtext: - - key: content_markdown - - Custome callout with title in a box. - icon: - - key: icon_param - - document - definitions: - shortcode_name: call-out - content_key: content_markdown - positional_args: - - editor_key: icon_param - type: string - - editor_key: callout_title - type: string - Internal comment: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Comment (Internal only) - subtext: - - key: content_markdown - - Internal comment that will not be rendered in the page. - icon: tag - definitions: - shortcode_name: comment - content_key: content_markdown - named_args: [] - include: - template: hugo_shortcode_positional_args - inline: true - preview: - text: Include - subtext: - - key: url - - Include snippet. - icon: file_copy - definitions: - shortcode_name: include - positional_args: - - editor_key: url - type: string - bootstrap-table: - template: hugo_paired_shortcode_positional_args - inline: false - preview: - text: Bootstrap Table - subtext: - - key: content_markdown_table - - type: code - - Markdown table using Bootstrap. - icon: table_chart - definitions: - shortcode_name: bootstrap-table - content_key: content_markdown_table - positional_args: - - editor_key: table_style - _inputs: - content_markdown_table: - type: code - cascade: true - raw-html: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: Raw HTML - subtext: - - key: content_code_block - - Raw HTML Code. - icon: html - definitions: - shortcode_name: raw-html - content_key: content_code_block - named_args: [] - img: - template: hugo_shortcode_named_args - inline: true - preview: - text: - - key: src - - Image - subtext: - - key: alt - - Alternative text - icon: image - definitions: - shortcode_name: img - named_args: - - editor_key: src - type: string - - editor_key: caption - optional: true - type: string - - editor_key: alt - optional: true - type: string - - editor_key: width - optional: true - type: string - - editor_key: height - optional: true - type: string - tab group: - template: hugo_paired_shortcode_named_args - inline: false - preview: - text: - - key: name - - Tab group section - subtext: - - key: content_code_block - - Tabs content - icon: tab - definitions: - shortcode_name: tabs - content_key: content_code_block - named_args: - - editor_key: name - type: string - tab section: - template: hugo_paired_markdown_shortcode_named_args - inline: false - preview: - text: - - key: name - - Tab inside tabbed section - subtext: - - key: tab_content - - Tab content - icon: tab - definitions: - shortcode_name: tabs - content_key: tab_content - named_args: - - editor_key: name - type: string - beta-badge: - template: hugo_shortcode_positional_args - inline: false - preview: - text: This topic documents an early access feature. - subtext: >- - These features are provided for you to try before they are generally - available. You shouldn't use early access features for production - purposes. - icon: science - definitions: - shortcode_name: beta-badge - relref: - template: hugo_shortcode_positional_args - inline: true - preview: - view: inline - icon: link - text: - - key: url - - Empty URL - definitions: - shortcode_name: relref - positional_args: - - editor_key: url - type: string - link: - template: hugo_shortcode_positional_args - inline: true - preview: - text: - - key: text - - Link to download a file - icon: system_update_alt - definitions: - shortcode_name: link - positional_args: - - editor_key: url - type: string - - editor_key: text - fontawesome-Icon: - template: hugo_shortcode_positional_args - inline: true - preview: - view: inline - text: FA-icon - icon: - - key: icon_name - definitions: - shortcode_name: fa - positional_args: - - editor_key: icon_name - type: string - - editor_key: styles - type: string - optional: true - remove_empty: true - icon-resolved: - template: hugo_markdown_shortcode_named_args - inline: true - preview: - text: Resolved Bug Icon - icon: bug_report - definitions: - shortcode_name: icon-resolved - content_key: content_markdown - named_args: [] - icon-bug: - template: hugo_markdown_shortcode_named_args - inline: true - preview: - text: Bug Icon - icon: bug_report - definitions: - shortcode_name: icon-bug - content_key: content_markdown - named_args: [] - shortversions: - template: hugo_shortcode_positional_args - inline: false - preview: - text: Shortversions - This shortcode has been deprecated - icon: format_list_numbered - definitions: - shortcode_name: shortversions - positional_args: - - editor_key: from - type: string - - editor_key: to - type: string - - editor_key: product - type: string - versions: - template: hugo_shortcode_positional_args - inline: false - preview: - text: Versions - This shortcode has been deprecated - icon: format_list_numbered - definitions: - shortcode_name: versions - positional_args: - - editor_key: from - type: string - - editor_key: to - type: string - - editor_key: product - type: string