Skip to content

Commit

Permalink
docs: DOC-1131 DOC-1132 Minor fixes 3 28 (#2492) (#2496)
Browse files Browse the repository at this point in the history
* docs: DOC-1131

* docs: DOC-1132

* docs: fix webp <-> png issues

---------

Co-authored-by: Carolina Delwing Rosa <[email protected]>
  • Loading branch information
karl-cardenas-coding and caroldelwing authored Mar 28, 2024
1 parent 8dca415 commit 1c8de72
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 15 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/registries-and-packs/add-custom-packs.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ _Manifests_ and _Ansible_ roles need to be explicitly templatized if parameter c
<templatized role2 parameters>
```
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:

Expand Down Expand Up @@ -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
Expand Down
16 changes: 7 additions & 9 deletions docs/docs-content/registries-and-packs/deploy-pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

</TabItem>
Expand Down Expand Up @@ -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.
```

</TabItem>
Expand Down Expand Up @@ -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.
```

<br />
Expand Down Expand Up @@ -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.

<br />

- **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.

<br />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
```
Expand All @@ -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
```
Expand Down

0 comments on commit 1c8de72

Please sign in to comment.