isabella232 / dox-installer-for-aemaacs

DoX integrator module for existing AEMaaCS customers

Steps for adding XML Documentation Solution

Follow this step-by-step guide to integrate DoX module to your existing code repository.

Adding DoX module

• Create a clone of your Cloud Manager's Git repository.

• Copy the DoX module from this repository to root directory of the cloud manager code.

• Update /dox/pom.xml

  • Replace the parent pom section with your parent's pom details, as shown below:

• Update the artifact Id as per your application's naming convention:

• Update /dox/dox.installer/pom.xml

  • Update the artifact id as per your application's naming conventions.
  • Add AEM Maven repository credentials for the XML Documentation solution package. These are shared in the welcome email.

• Add the XML Documentation solution module in the parent pom module section.

[Optional] Overriding DoX OSGI Configurations

This is an optional configuration, which is required only if you have existing OSGi configurations that you want to retain. In case you do not have any OSGi configurations to override, then you have an option of deleting the dox/dox.config.override folder.

For more details on configuring OSGi, see OSGi Configuration in the Repository in AEM's documentation

• Add your OSGI properties overrides in the below files
  • src/main/content/jcr_root/apps/fmditaCustom/config/com.adobe.fmdita.config.ConfigManager.xml
  • src/main/content/jcr_root/apps/fmditaCustom/config/com.adobe.fmdita.xmleditor.config.XmlEditorConfig.xml
• You can also add more properties with the relevant PID to override other XML Documentation solution specific OSGI properties
• Commit the changes and run the Cloud Manager pipeline to deploy configuration changes.

[Optional] Enable Edit in Oxygen feature

You can enable the Edit in Oxygen feature by adding the package details in the pom.xml file. In case you do not want to enable this feature, then you have an option of deleting the dox/dox.openinoxygen.installer folder.

• Add dox.openinoxygen.installer module in /dox/pom.xml
• Add AEM Maven repository credentials for the open-in-oxygen package. These are shared in the welcome email.