review

.github/workflows/docs.yml

@@ -1,7 +1,7 @@
 name: Publish docs
 
 permissions:
-  contents: write # FIXME: remove this line when the permissions issue is resolved
+  contents: write
   pages: write
   id-token: write
 
@@ -21,7 +21,7 @@ on:
 
 jobs:
   publish:
-    uses: Alfresco/jekyll-build-tools/.github/workflows/jekyll-publish.yml@OPSEXP-2620-workaround-validation-issues
+    uses: Alfresco/jekyll-build-tools/.github/workflows/jekyll-publish.yml@main
     with:
       working-directory: .
       publish: ${{ github.event_name == 'push' && github.ref_name == 'master'}}

README.md → docs/README.md

@@ -1,5 +1,20 @@
 # Alfresco Content Services Containerized Deployment
 
+[![release](https://img.shields.io/github/v/release/Alfresco/acs-deployment?display_name=release)](https://github.com/Alfresco/acs-deployment/releases/latest)
+![kubernetes tested version](https://img.shields.io/badge/k8s%20version-v1.29-blue)
+[![Helm release](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-release.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-release.yml)
+
+[![helm charts (enterprise)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-enterprise.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-enterprise.yml)
+[![helm charts (community)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-community.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/helm-community.yml)
+
+[![docker-compose (enterprise)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-enterprise.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-enterprise.yml)
+[![docker-compose (community)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-community.yml/badge.svg)](https://github.com/Alfresco/acs-deployment/actions/workflows/docker-compose-community.yml)
+
+This project contains the code for running Alfresco Content Services (ACS) with
+[Docker](https://docs.docker.com/get-started) using [Docker
+Compose](https://docs.docker.com/compose) or on
+[Kubernetes](https://kubernetes.io) using [Helm Charts](https://helm.sh).
+
 User docs available at: [https://alfresco.github.io/acs-deployment/](https://alfresco.github.io/acs-deployment/)
 
 ## License

docs/docker-compose/README.md

@@ -116,7 +116,7 @@ suited for test or demo environment but certainly not for production use.
 ## Prerequisites
 
 As well as the prerequisites mentioned on the [main
-README](/index.html#prerequisites) you will need a machine with at least 13GB of
+README](/index.md#prerequisites) you will need a machine with at least 13GB of
 free memory and the following software installed:
 
 * [Docker](https://www.docker.com/products/docker-desktop)

docs/helm/README.md

@@ -87,9 +87,9 @@ There are also several [examples](../helm-examples.md) showing how to deploy wit
 * [Deploy with external Keycloak SSO authentication](./examples/with-keycloak.md)
 * [Deploy with external infrastructure components](./examples/with-external-infrastructure.md) (e.g. elasticsearch, activemq, postgres)
 * [Enable access to Search Services](./examples/search-services.md#enable-alfresco-search-services-external-access)
-* [Enable Email Services](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-repository/docs/email.md)
-* [Use a custom metadata keystore](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-repository/docs/keystores.md)
-* [Install ACS license as part of the deployment](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-repository/docs/enterprise-license.md)
+* [Enable Email Services](https://alfresco.github.io/alfresco-helm-charts/charts/alfresco-repository/docs/email.html)
+* [Use a custom metadata keystore](https://alfresco.github.io/alfresco-helm-charts/charts/alfresco-repository/docs/keystores.html)
+* [Install ACS license as part of the deployment](https://alfresco.github.io/alfresco-helm-charts/charts/alfresco-repository/docs/enterprise-license.html)
 
 ## Upgrade
 

docs/helm/desktop-deployment.md

@@ -13,7 +13,7 @@ Desktop](https://docs.docker.com/desktop/).
 
 ## Prerequisites
 
-- You've read the projects [main README](/index.html#prerequisites)
+- You've read the projects [main README](/index.md#prerequisites)
 prerequisites section
 - You've read the [main Helm README](./README.md) page
 - You are proficient in Kubernetes

docs/helm/eks-deployment.md

@@ -24,7 +24,7 @@ The Community configuration will deploy the following system:
 
 ## Prerequisites
 
-* You've read the projects [main README](/index.html#prerequisites)
+* You've read the projects [main README](/index.md#prerequisites)
   prerequisites section
 * You've read the [main Helm README](./README.md) page
 * You are proficient in AWS and Kubernetes