docs: hive-metastore documentation audit

README.md

@@ -1,29 +1,39 @@
 [![ci](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml)
 [![release-please](https://github.com/okdp/hive-metastore/actions/workflows/release-please.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/release-please.yml)
+[![Release](https://img.shields.io/github/v/release/okdp/hive-metastore)](https://github.com/okdp/hive-metastore/releases/latest)  
+[![Helm](https://img.shields.io/badge/helm-3+-blue.svg)](https://helm.sh/)
+[![Kubernetes](https://img.shields.io/badge/kubernetes-1.19+-blue.svg)](https://kubernetes.io/)  
 [![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+<a href="https://okdp.io">
+  <img src="https://okdp.io/logos/okdp-notext.svg" height="20px" style="margin: 0 2px;" />
+</a>
 
-<p align="center">
-    <img width="400px" height=auto src="https://okdp.io/logos/okdp-inverted.png" />
-</p>
+An [Apache Hive Metastore](https://cwiki.apache.org/confluence/display/hive/design#Design-Metastore) Docker image and Helm chart for Kubernetes, part of the [OKDP](https://okdp.io) (Open Kubernetes Data Platform) ecosystem.
 
-This repo contains:
+This repository contains:
 
-- A Dockerfile and associated scripts to build the `hive-metastore` docker image.
-- A corresponding helm chart.
+- A **Dockerfile** and associated scripts to build the `hive-metastore` Docker image — published to [quay.io/okdp/hive-metastore](https://quay.io/repository/okdp/hive-metastore)
+- A corresponding **Helm chart** — published to [quay.io/okdp/charts/hive-metastore](https://quay.io/repository/okdp/charts/hive-metastore)
 
-A postgresql server with an empty database is to be provided. An init job will take care of creating the DB schema.
+A PostgreSQL server with an empty database is to be provided. An init job will take care of creating the DB schema.
 
 Also, access to the target S3 service is required.
 
-## Installation
-
-Refer to [README](helm/hive-metastore/README.md) for the customization and installation guide.
-
 ## Requirements
 
 - Kubernetes cluster
 - [Helm](https://helm.sh/) installed
 
+## Installation
+
+Refer to the [Helm chart README](helm/hive-metastore/README.md) for the customization and installation guide.
+
 > [!NOTE]
-> An OKDP sandbox, with all these helm charts installed, is under development and you can use it once released.
-> 
+> An OKDP sandbox with all these helm charts pre-installed and ready to use is available at [okdp-sandbox](https://github.com/OKDP/okdp-sandbox).
+
+---
+
+**Built for the OKDP Community**
+<a href="https://okdp.io">
+  <img src="https://okdp.io/logos/okdp-notext.svg" height="20px" style="margin: 0 2px;" />
+</a>

helm/hive-metastore/Chart.yaml

@@ -14,9 +14,9 @@
 # limitations under the License.
 #
 
-# File generated by Makefile
 apiVersion: v2
 name: hive-metastore
+description: A Helm chart to deploy Apache Hive Metastore on Kubernetes, with PostgreSQL backend and S3 warehouse storage.
 version: 1.4.0
 sources:
   - https://github.com/okdp/hive-metastore

helm/hive-metastore/README.md

@@ -16,8 +16,19 @@
 
 -->
 
+[![ci](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml)
+[![Release](https://img.shields.io/github/v/release/okdp/hive-metastore)](https://github.com/okdp/hive-metastore/releases/latest)  
+[![Helm](https://img.shields.io/badge/helm-3+-blue.svg)](https://helm.sh/)
+[![Kubernetes](https://img.shields.io/badge/kubernetes-1.19+-blue.svg)](https://kubernetes.io/)  
+[![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+<a href="https://okdp.io">
+  <img src="https://okdp.io/logos/okdp-notext.svg" height="20px" style="margin: 0 2px;" />
+</a>
+
 # hive-metastore
 
+A Helm chart to deploy Apache Hive Metastore on Kubernetes, with PostgreSQL backend and S3 warehouse storage.
+
 ## Introduction
 
 This chart bootstraps a [Hive Metastore](https://cwiki.apache.org/confluence/display/hive/design#Design-Metastore) deployment using the [Helm](https://helm.sh) package manager.
@@ -26,6 +37,8 @@ This chart bootstraps a [Hive Metastore](https://cwiki.apache.org/confluence/dis
 
 - Helm >= 3
 - Kubernetes >= 1.19
+- A PostgreSQL server with an empty database (an init job will create the schema automatically)
+- Access to an S3 service for the warehouse storage
 
 ## Installing the chart
 

helm/hive-metastore/README.md.gotmpl

@@ -16,6 +16,15 @@
 
 -->
 
+[![ci](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml)
+[![Release](https://img.shields.io/github/v/release/okdp/hive-metastore)](https://github.com/okdp/hive-metastore/releases/latest)  
+[![Helm](https://img.shields.io/badge/helm-3+-blue.svg)](https://helm.sh/)
+[![Kubernetes](https://img.shields.io/badge/kubernetes-1.19+-blue.svg)](https://kubernetes.io/)  
+[![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+<a href="https://okdp.io">
+  <img src="https://okdp.io/logos/okdp-notext.svg" height="20px" style="margin: 0 2px;" />
+</a>
+
 {{ template "chart.header" . }}
 
 {{ template "chart.description" . }}
@@ -30,6 +39,8 @@ This chart bootstraps a [Hive Metastore](https://cwiki.apache.org/confluence/dis
 
 - Helm >= 3
 - Kubernetes >= 1.19
+- A PostgreSQL server with an empty database (an init job will create the schema automatically)
+- Access to an S3 service for the warehouse storage
 
 ## Installing the chart