From 1c8de72e3d611636fe1ebd801851334ae7e540e3 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 28 Mar 2024 10:30:17 -0700 Subject: [PATCH] docs: DOC-1131 DOC-1132 Minor fixes 3 28 (#2492) (#2496) * docs: DOC-1131 * docs: DOC-1132 * docs: fix webp <-> png issues --------- Co-authored-by: Carolina Delwing Rosa --- .../integrations/splunk.md | 0 .../services/service-listings/cockroach-db.md | 2 +- .../registries-and-packs/add-custom-packs.md | 4 ++-- .../registries-and-packs/deploy-pack.md | 16 +++++++--------- .../registries-and-packs/registries-and-packs.md | 6 +++--- 5 files changed, 13 insertions(+), 15 deletions(-) rename docs/{docs-content => deprecated}/integrations/splunk.md (100%) diff --git a/docs/docs-content/integrations/splunk.md b/docs/deprecated/integrations/splunk.md similarity index 100% rename from docs/docs-content/integrations/splunk.md rename to docs/deprecated/integrations/splunk.md diff --git a/docs/docs-content/devx/services/service-listings/cockroach-db.md b/docs/docs-content/devx/services/service-listings/cockroach-db.md index a38a493128..f8c263c659 100644 --- a/docs/docs-content/devx/services/service-listings/cockroach-db.md +++ b/docs/docs-content/devx/services/service-listings/cockroach-db.md @@ -6,7 +6,7 @@ hide_table_of_contents: false type: "appTier" category: ["databases"] sidebar_position: 50 -logoUrl: "https://upload.wikimedia.org/wikipedia/en/thumb/3/31/Cockroach_Labs_Logo.webp/220px-Cockroach_Labs_Logo.webp" +logoUrl: "https://upload.wikimedia.org/wikipedia/en/thumb/3/31/Cockroach_Labs_Logo.png/220px-Cockroach_Labs_Logo.png" tags: ["devx", "app mode", "pde", "databases"] --- diff --git a/docs/docs-content/registries-and-packs/add-custom-packs.md b/docs/docs-content/registries-and-packs/add-custom-packs.md index dbd3c2f58d..bfaa74e88f 100644 --- a/docs/docs-content/registries-and-packs/add-custom-packs.md +++ b/docs/docs-content/registries-and-packs/add-custom-packs.md @@ -296,7 +296,7 @@ _Manifests_ and _Ansible_ roles need to be explicitly templatized if parameter c ``` -4. A pack must have the logo file named `logo.webp` and must be copied into the pack directory. +4. A pack must have the logo file named `logo.png` and must be copied into the pack directory. 5. Login to the pack registry using the following command: @@ -467,7 +467,7 @@ final directory structure of for the pack would be as follows: ``` ./pack.json -./logo.webp +./logo.png ./values.yaml ./harden_os ./harden_os/tasks diff --git a/docs/docs-content/registries-and-packs/deploy-pack.md b/docs/docs-content/registries-and-packs/deploy-pack.md index de442f02c1..98bf13860b 100644 --- a/docs/docs-content/registries-and-packs/deploy-pack.md +++ b/docs/docs-content/registries-and-packs/deploy-pack.md @@ -163,8 +163,8 @@ structure for each: ├── manifest-1.yaml ├── manifest-2.yaml │ └── manifest-3.yaml -├── logo.webp # Mandatory -└── README.md # Optional +├── logo.png # Mandatory. +└── README.md # Optional. ``` @@ -192,8 +192,8 @@ structure for each: │ │ │ └── template-2.yaml │ │ └── values.yaml # Chart-level values.yaml file. │ └── chart-2.tgz -├── logo.webp # Mandatory -└── README.md # Optional +├── logo.png # Mandatory. +└── README.md # Optional. ``` @@ -221,8 +221,8 @@ Ensure you have the following files in the current directory. ├── values.yaml # Mandatory ├── manifests # Mandatory │ └── hello-universe.yaml -├── logo.webp # Mandatory -└── README.md # Optional +├── logo.png # Mandatory. +└── README.md # Optional. ```
@@ -294,9 +294,7 @@ Go ahead and review each of the following five files in the pack. file, **hello-universe.yaml**. Note that the **values.yaml** file has a corresponding `manifests/hello-universe` element with the same name as the YAML file. -
- -- **logo.webp** - This file contains a logo that displays when you create a cluster profile. +- **logo.png** - This file contains a logo that displays when you create a cluster profile.
diff --git a/docs/docs-content/registries-and-packs/registries-and-packs.md b/docs/docs-content/registries-and-packs/registries-and-packs.md index 98975b5377..b65272e319 100644 --- a/docs/docs-content/registries-and-packs/registries-and-packs.md +++ b/docs/docs-content/registries-and-packs/registries-and-packs.md @@ -42,7 +42,7 @@ the Kubernetes clusters after deployment. The following is a typical pack struct | `charts/` | mandatory | Mandatory for Helm chart-based packs. Contains the Helm charts to be deployed for the pack. | | `manifests/` | mandatory | Mandatory for Manifest-based packs. Contains the manifest files to be deployed for the pack. | | `ansible-roles` | optional | Ansible roles used to install the pack. | -| `logo.webp` | optional | Contains the pack logo. | +| `logo.png` | optional | Contains the pack logo. | | `README.md` | optional | The pack description. | Let's look at the examples below to better understand pack structure. @@ -68,7 +68,7 @@ pack-level **values.yaml** file and individual chart-level **values.yaml** files │      ├── Chart.yaml │      ├── templates/ │      └── values.yaml -├── logo.webp +├── logo.png ├── pack.json └── values.yaml ``` @@ -85,7 +85,7 @@ This example shows the structure of a Manifest-based pack, _kubeflow-1.2.0_, mad ├── manifests/ │   ├── kubeflow-kfdef.yaml │   └── kubeflow-operator.yaml -├── logo.webp +├── logo.png ├── pack.json └── values.yaml ```