From 49a8b4f8bee432bb159366c6a7c784c6c1d10176 Mon Sep 17 00:00:00 2001 From: Dominik Przybyl Date: Mon, 17 Jun 2024 16:15:59 +0200 Subject: [PATCH] docs --- Makefile | 2 +- README.md | 4 +-- docs/_index.md | 8 +++--- docs/index.md | 6 ++--- docs/installation-configuration.md | 26 +++++++++++++++++--- docs/resources/instance.md | 4 +-- provider/cmd/pulumi-resource-aem/schema.json | 4 +-- provider/description.md | 2 +- provider/provider.go | 2 +- sdk/dotnet/Compose/README.md | 4 +-- sdk/dotnet/README.md | 4 +-- sdk/dotnet/WTTech.Aem.csproj | 2 +- sdk/dotnet/version.txt | 2 +- sdk/go/README.md | 4 +-- sdk/go/aem/doc.go | 2 +- sdk/nodejs/README.md | 4 +-- sdk/python/README.md | 4 +-- sdk/python/setup.py | 2 +- sdk/python/wttech_aem/README.md | 4 +-- 19 files changed, 54 insertions(+), 36 deletions(-) diff --git a/Makefile b/Makefile index f0ea938..28f9401 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -PROJECT_NAME := Pulumi AEM Compose Provider +PROJECT_NAME := Pulumi Adobe Experience Manager Provider PACK := aem MOD := compose diff --git a/README.md b/README.md index 6a13a19..1a1b25a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment. diff --git a/docs/_index.md b/docs/_index.md index 7ec23cd..af37eef 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,12 +1,12 @@ --- -title: AEM -meta_desc: Provides an overview of the AEM Provider for Pulumi. +title: Adobe Experience Manager Provider +meta_desc: Provides an overview of the Adobe Experience Manager Provider for Pulumi. layout: package --- -## AEM Provider for Pulumi +## Adobe Experience Manager Provider for Pulumi -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. ## Example diff --git a/docs/index.md b/docs/index.md index f451503..536c757 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,14 @@ --- -page_title: "AEM Provider" +page_title: "Adobe Experience Manager Provider" subcategory: "" --- [![AEM Compose Logo](https://raw.githubusercontent.com/wttech/pulumi-aem/main/docs/logo-with-text.png)](https://github.com/wttech/aemc) [![WTT Logo](https://raw.githubusercontent.com/wttech/pulumi-aem/main/docs/wtt-logo.png)](https://www.wundermanthompson.com/service/technology) -# AEM Provider +# Adobe Experience Manager Provider -This provider allows developers and development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows developers and development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. ## Purpose diff --git a/docs/installation-configuration.md b/docs/installation-configuration.md index b64da7b..d385e66 100644 --- a/docs/installation-configuration.md +++ b/docs/installation-configuration.md @@ -1,18 +1,36 @@ --- -title: AEM Installation & Configuration -meta_desc: Information on how to install the AEM provider. +title: Adobe Experience Manager Provider Installation & Configuration +meta_desc: Information on how to install the Adobe Experience Manager provider. layout: package --- ## Installation -The AEM provider is available as a package in following Pulumi languages: +The Adobe Experience Manager provider is available as a package in following Pulumi languages: * JavaScript/TypeScript: [`@wttech/aem`](https://www.npmjs.com/package/@wttech/aem) * Python: [`wttech_aem`](https://pypi.org/project/wttech-aem/) * Go: [`github.com/wttech/pulumi-aem/sdk/go/aem`](https://pkg.go.dev/github.com/wttech/pulumi-aem/sdk) * .NET: [`WTTech.Aem`](https://www.nuget.org/packages/WTTech.Aem) +### Provider Binary + +The Adobe Experience Manager provider binary is a third party binary. It can be installed using the `pulumi plugin` command. + +```bash +pulumi plugin install resource aem --server github://api.github.com/wttech +``` + +Replace the version string with your desired version. + ## Setup -To provision resources with the Pulumi AEM provider, you need to have correct configuration towards your AWS or other cloud controller. +To provision resources with the Pulumi Adobe Experience Manager provider, you need to have correct configuration towards your AWS or other cloud controller. + +### Set environment variables + +The Adobe Experience Manager provider does not use any specific environment variables. + +## Configuration Options + +The Adobe Experience Manager provider does not require any additional options. diff --git a/docs/resources/instance.md b/docs/resources/instance.md index d40fe5c..18968d8 100644 --- a/docs/resources/instance.md +++ b/docs/resources/instance.md @@ -1,12 +1,12 @@ --- -page_title: "AEM Provider - Resource 'aem_instance'" +page_title: "Adobe Experience Manager Provider - Resource 'aem_instance'" subcategory: "" --- [![AEM Compose Logo](https://raw.githubusercontent.com/wttech/pulumi-aem/main/docs/logo-with-text.png)](https://github.com/wttech/aemc) [![WTT Logo](https://raw.githubusercontent.com/wttech/pulumi-aem/main/docs/wtt-logo.png)](https://www.wundermanthompson.com/service/technology) -# AEM Provider - Resource 'aem_instance' +# Adobe Experience Manager Provider - Resource 'aem_instance' The instance resource allows you to create and manage AEM instances. diff --git a/provider/cmd/pulumi-resource-aem/schema.json b/provider/cmd/pulumi-resource-aem/schema.json index a202206..62b274f 100644 --- a/provider/cmd/pulumi-resource-aem/schema.json +++ b/provider/cmd/pulumi-resource-aem/schema.json @@ -1,8 +1,8 @@ { "name": "aem", "displayName": "Adobe Experience Manager", - "version": "0.1.2-alpha.1717632695+85d1fce1", - "description": "Easily manage Adobe Experience Manager (AEM) instances in the cloud without a deep dev-ops knowledge", + "version": "0.1.2-alpha.1718635808+2feb6b9e", + "description": "Easily manage Adobe Experience Manager instances in the cloud without a deep dev-ops knowledge", "keywords": [ "pulumi", "aem", diff --git a/provider/description.md b/provider/description.md index 0b227c6..3705135 100644 --- a/provider/description.md +++ b/provider/description.md @@ -1,4 +1,4 @@ -This provider allows developers and development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows developers and development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. ## Purpose diff --git a/provider/provider.go b/provider/provider.go index 8169020..5ec8544 100644 --- a/provider/provider.go +++ b/provider/provider.go @@ -31,7 +31,7 @@ func Provider() p.Provider { Repository: "https://github.com/wttech/pulumi-aem", License: "Apache-2.0", LogoURL: "https://raw.githubusercontent.com/wttech/pulumi-aem/main/docs/logo.175.png", - Description: "Easily manage Adobe Experience Manager (AEM) instances in the cloud without a deep dev-ops knowledge", + Description: "Easily manage Adobe Experience Manager instances in the cloud without a deep dev-ops knowledge", DisplayName: "Adobe Experience Manager", Keywords: []string{"pulumi", "aem", "aemc", "category/cloud"}, LanguageMap: map[string]any{ diff --git a/sdk/dotnet/Compose/README.md b/sdk/dotnet/Compose/README.md index 6a13a19..1a1b25a 100644 --- a/sdk/dotnet/Compose/README.md +++ b/sdk/dotnet/Compose/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment. diff --git a/sdk/dotnet/README.md b/sdk/dotnet/README.md index 6a13a19..1a1b25a 100644 --- a/sdk/dotnet/README.md +++ b/sdk/dotnet/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment. diff --git a/sdk/dotnet/WTTech.Aem.csproj b/sdk/dotnet/WTTech.Aem.csproj index 970c428..9fbce40 100644 --- a/sdk/dotnet/WTTech.Aem.csproj +++ b/sdk/dotnet/WTTech.Aem.csproj @@ -4,7 +4,7 @@ true Pulumi Corp. Pulumi Corp. - Easily manage Adobe Experience Manager (AEM) instances in the cloud without a deep dev-ops knowledge + Easily manage Adobe Experience Manager instances in the cloud without a deep dev-ops knowledge Apache-2.0 https://github.com/wttech/pulumi-aem https://github.com/wttech/pulumi-aem diff --git a/sdk/dotnet/version.txt b/sdk/dotnet/version.txt index 015edb1..1ab80b5 100644 --- a/sdk/dotnet/version.txt +++ b/sdk/dotnet/version.txt @@ -1 +1 @@ -0.1.2-alpha.1717632695+85d1fce1 +0.1.2-alpha.1718635808+2feb6b9e diff --git a/sdk/go/README.md b/sdk/go/README.md index 6a13a19..1a1b25a 100644 --- a/sdk/go/README.md +++ b/sdk/go/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment. diff --git a/sdk/go/aem/doc.go b/sdk/go/aem/doc.go index c018b0f..88f3f55 100644 --- a/sdk/go/aem/doc.go +++ b/sdk/go/aem/doc.go @@ -1,2 +1,2 @@ -// Easily manage Adobe Experience Manager (AEM) instances in the cloud without a deep dev-ops knowledge +// Easily manage Adobe Experience Manager instances in the cloud without a deep dev-ops knowledge package aem diff --git a/sdk/nodejs/README.md b/sdk/nodejs/README.md index 6a13a19..1a1b25a 100644 --- a/sdk/nodejs/README.md +++ b/sdk/nodejs/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment. diff --git a/sdk/python/README.md b/sdk/python/README.md index 6a13a19..1a1b25a 100644 --- a/sdk/python/README.md +++ b/sdk/python/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment. diff --git a/sdk/python/setup.py b/sdk/python/setup.py index c5be091..1fdb16d 100644 --- a/sdk/python/setup.py +++ b/sdk/python/setup.py @@ -21,7 +21,7 @@ def readme(): setup(name='wttech_aem', python_requires='>=3.8', version=VERSION, - description="Easily manage Adobe Experience Manager (AEM) instances in the cloud without a deep dev-ops knowledge", + description="Easily manage Adobe Experience Manager instances in the cloud without a deep dev-ops knowledge", long_description=readme(), long_description_content_type='text/markdown', keywords='pulumi aem aemc category/cloud', diff --git a/sdk/python/wttech_aem/README.md b/sdk/python/wttech_aem/README.md index 6a13a19..1a1b25a 100644 --- a/sdk/python/wttech_aem/README.md +++ b/sdk/python/wttech_aem/README.md @@ -5,7 +5,7 @@ # AEM Compose - Pulumi Native Provider -This provider allows development teams to easily set up [Adobe Experience Manager (AEM)](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. +This provider allows development teams to easily set up [Adobe Experience Manager](https://business.adobe.com/products/experience-manager/adobe-experience-manager.html) instances on virtual machines in the cloud (AWS, Azure, GCP, etc.) or bare metal machines. It's based on the [AEM Compose](https://github.com/wttech/aemc) tool and aims to simplify the process of creating AEM environments without requiring deep DevOps knowledge. Published in [Pulumi Registry](https://www.pulumi.com/registry/packages/aem/). @@ -73,7 +73,7 @@ If you are not using VSCode, you will need to ensure the following tools are ins * [.NET](https://dotnet.microsoft.com/download) -#### Build & test the AEM provider +#### Build & test the Adobe Experience Manager provider 1. Create a new Github CodeSpaces environment using this repository. 1. Open a terminal in the CodeSpaces environment.