From 35b7a5a716437d17e22cf6869465f7339840f51a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Maciusiak?= <158472457+pmacius@users.noreply.github.com> Date: Thu, 5 Dec 2024 15:39:06 +0100 Subject: [PATCH] OPSEXP-2929 Point links to support.hyland.com (#1265) --- README.md | 3 +++ _config.yml | 1 + docs/docker-compose/README.md | 8 ++++++-- docs/helm/eks-deployment.md | 20 +++++++++----------- docs/helm/examples/external-hazelcast.md | 5 +++-- docs/helm/examples/with-keycloak.md | 5 +++-- docs/helm/examples/with-ms-teams.md | 2 +- helm/alfresco-content-services/README.md | 2 +- helm/alfresco-content-services/values.yaml | 2 +- 9 files changed, 28 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a166a3ad4..22ffc8af6 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,9 @@ First ensure that: Start the release by opening a PR against the appropriate branch that will: * Update the [EOL table](docs/index.md#acs-end-of-lifed-versions) in case a version is deprecated +* For minor releases, ensure to update the links beginning with + `https://support.hyland.com/r/Alfresco` to reflect the latest version or + corresponding minor update documentation. * In [alfresco-content-services](helm/alfresco-content-services/Chart.yaml) and [acs-sso-example](helm/acs-sso-example/Chart.yaml) charts:bump chart version to the version you want to release. diff --git a/_config.yml b/_config.yml index 944ee6a3d..44fe80476 100644 --- a/_config.yml +++ b/_config.yml @@ -6,6 +6,7 @@ color_scheme: alfresco url: https://alfresco.github.io aux_links: + Hyland Support: https://support.hyland.com/p/alfresco Docs: https://docs.alfresco.com/ GitHub Repository: https://github.com/Alfresco/acs-deployment diff --git a/docs/docker-compose/README.md b/docs/docker-compose/README.md index c6c72c8a0..7dd0e9015 100644 --- a/docs/docker-compose/README.md +++ b/docs/docker-compose/README.md @@ -153,7 +153,8 @@ Docker Daemon). apply your license: * `http://:8080/alfresco/service/enterprise/admin/admin-license` (`` will usually just be `localhost`) * Default username and password is `admin` - * See [Uploading a new license](https://docs.alfresco.com/content-services/latest/admin/license/#uploadlicense) for more details + * See [Uploading a new license][upload-new-license] + for more details ### Choosing a search engine @@ -383,7 +384,7 @@ share: | Property | Description | Default value | |-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| -| JAVA_OPTS | A set of properties that are picked up by the JVM inside the container. Any Sync Service property can be passed to the container using the following format `"-Dproperty=value"` (e.g. `-Dsql.db.username=alfresco`) . For a complete list of properties that can be passed through JAVA_OPTS enviroment variable, please check the [documentation](https://docs.alfresco.com/syncservice/concepts/syncservice-configure.html) | | +| JAVA_OPTS | A set of properties that are picked up by the JVM inside the container. Any Sync Service property can be passed to the container using the following format `"-Dproperty=value"` (e.g. `-Dsql.db.username=alfresco`) . For a complete list of properties that can be passed through JAVA_OPTS enviroment variable, please check the [documentation][sync-service-configure] | | ### Alfresco Proxy (proxy) @@ -444,3 +445,6 @@ The list below shows the location of the publicly available `Dockerfile` for the * [solr6](https://github.com/Alfresco/SearchServices/blob/master/search-services/packaging/src/docker/Dockerfile) * [transform-core-aio](https://github.com/Alfresco/alfresco-transform-core/blob/master/engines/aio/Dockerfile) * [activemq](https://github.com/Alfresco/alfresco-docker-activemq/blob/master/Dockerfile) + +[upload-new-license]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Licenses/Upload-new-license +[sync-service-configure]: https://support.hyland.com/r/Alfresco/Alfresco-Sync-Service/5.1/Alfresco-Sync-Service/Configure diff --git a/docs/helm/eks-deployment.md b/docs/helm/eks-deployment.md index 50a6f3319..e427740ae 100644 --- a/docs/helm/eks-deployment.md +++ b/docs/helm/eks-deployment.md @@ -293,9 +293,7 @@ that we need to perform before ACS can be successfully installed. There are multiple storage options available when deploying on AWS. -For the main -[content-store](https://docs.alfresco.com/content-services/latest/admin/content-stores/), -you can alternatively: +For the main [content-store][administer-content-stores], you can alternatively: * Use an Elastic File System, installing the ([EFS CSI driver](#efs-csi-driver)) (the default, as documented below, required when repository replicas are more @@ -305,16 +303,13 @@ you can alternatively: zone - not meant for production) * Use an [S3](examples/with-aws-services.md#s3) bucket -For the -[database](https://docs.alfresco.com/content-services/latest/config/databases/), -you can alternatively: +For the [database][configure-databases], you can alternatively: * Use the embedded postgres instance provided by the helm chart by default, enabling [EBS CSI driver](#ebs-csi-driver) * Use [RDS](examples/with-aws-services.md#rds) -For the [messaging -broker](https://docs.alfresco.com/content-services/latest/config/activemq/), +For the [messaging broker][configure-activemq], you can alternatively: * Use the embedded activemq provided by the helm chart by default, enabling @@ -677,9 +672,7 @@ apply your license: * `https://acs.YOUR-DOMAIN-NAME/alfresco/service/enterprise/admin/admin-license` * Default username and password is ```admin``` -* See [Uploading a new - license](https://docs.alfresco.com/content-services/latest/admin/license/#uploadlicense) - for more details +* See [Uploading a new license][upload-new-license] for more details ## Configure @@ -715,3 +708,8 @@ Finally, delete the EKS cluster: ```sh eksctl delete cluster --name $EKS_CLUSTER_NAME ``` + +[administer-content-stores]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Content-stores +[configure-databases]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Configure/Databases +[configure-activemq]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Configure/Configure-ActiveMQ +[upload-new-license]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Licenses/Upload-new-license diff --git a/docs/helm/examples/external-hazelcast.md b/docs/helm/examples/external-hazelcast.md index 37588d7d7..fd2e610be 100644 --- a/docs/helm/examples/external-hazelcast.md +++ b/docs/helm/examples/external-hazelcast.md @@ -37,8 +37,7 @@ grand_parent: Helm 2. Prepare a valid Hazelcast xml configuration, which also must include different cache definitions depending on the ACS version. You can generate it - by following the steps in [Alfresco - docs](https://docs.alfresco.com/content-services/latest/admin/cluster/#set-up-repository-clustering-via-external-hazelcast). + by following the steps in [Hyland Support][external-hazelcast]. For testing you can use config generated by us on 23.2.0-M1 and skip to 7th step. - Example file: @@ -183,3 +182,5 @@ grand_parent: Helm ```bash ????????admin????(92023d8ea10294a2e32b238963e67d8013342e30 ``` + +[external-hazelcast]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/High-availability-features/Clustering/Set-up-repository-server-cluster/Set-up-repository-clustering-via-external-Hazelcast diff --git a/docs/helm/examples/with-keycloak.md b/docs/helm/examples/with-keycloak.md index b1bc582e9..edd16a335 100644 --- a/docs/helm/examples/with-keycloak.md +++ b/docs/helm/examples/with-keycloak.md @@ -96,5 +96,6 @@ alfresco-control-center: APP_CONFIG_OAUTH2_CLIENTID: YOUR-CLIENT-ID ``` -See [Identity Service tutorial](https://docs.alfresco.com/identity-service/latest/tutorial/sso/saml/#step-7-configure-alfresco-digital-workspace) -for more configuration options. +See [Identity Service tutorial][configure-adw] for more configuration options. + +[configure-adw]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Tutorials/Configure-Single-Sign-On/SAML/Configure-Alfresco-Digital-Workspace diff --git a/docs/helm/examples/with-ms-teams.md b/docs/helm/examples/with-ms-teams.md index 5c1875265..eb7c87610 100644 --- a/docs/helm/examples/with-ms-teams.md +++ b/docs/helm/examples/with-ms-teams.md @@ -6,7 +6,7 @@ grand_parent: Helm # ACS Helm Deployment with Microsoft Teams Connector -The [Alfresco Microsoft Teams Connector](https://docs.alfresco.com/) enables +The [Alfresco Microsoft Teams Connector](https://support.hyland.com/p/alfresco) enables Microsoft Teams clients to be used to search content within ACS and send messages to Teams Chat / Channels with preview links to Alfresco Digital Workspace. By default, this feature is disabled. diff --git a/helm/alfresco-content-services/README.md b/helm/alfresco-content-services/README.md index 0259b655b..334819ed2 100644 --- a/helm/alfresco-content-services/README.md +++ b/helm/alfresco-content-services/README.md @@ -264,7 +264,7 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b | global.auditIndex.url | string | `nil` | Elasticsearch URL | | global.auditIndex.username | string | `nil` | Elasticsearch username | | global.known_urls | list | `["https://localhost","http://localhost"]` | list of trusted URLs. URLs a re used to configure Cross-origin protections Also the first entry is considered the main hosting domain of the platform. | -| global.mail | object | `{"host":null,"password":null,"port":587,"protocol":"smtp","smtp":{"auth":true,"starttls":{"enable":true}},"smtps":{"auth":true},"username":"anonymous"}` | For a full information of configuring the outbound email system, see https://docs.alfresco.com/content-services/latest/config/email/#manage-outbound-emails | +| global.mail | object | `{"host":null,"password":null,"port":587,"protocol":"smtp","smtp":{"auth":true,"starttls":{"enable":true}},"smtps":{"auth":true},"username":"anonymous"}` | For a full information of configuring the outbound email system, see https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Configure/Email/Configure-Inbound-and-Outbound-Email/Manage-Outbound-Emails | | global.mail.host | string | `nil` | SMTP server to use for the system to send outgoing email | | global.mail.port | int | `587` | SMTP server port | | global.mail.protocol | string | `"smtp"` | SMTP protocol to use. Either smtp or smtps | diff --git a/helm/alfresco-content-services/values.yaml b/helm/alfresco-content-services/values.yaml index 5b4bb539a..463e0ab43 100644 --- a/helm/alfresco-content-services/values.yaml +++ b/helm/alfresco-content-services/values.yaml @@ -28,7 +28,7 @@ global: - https://localhost - http://localhost # -- For a full information of configuring the outbound email system, see - # https://docs.alfresco.com/content-services/latest/config/email/#manage-outbound-emails + # https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Configure/Email/Configure-Inbound-and-Outbound-Email/Manage-Outbound-Emails mail: # -- SMTP server to use for the system to send outgoing email host: null