Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Aem markdown importer github love in aem

80 views

Published on

AEM Markdown importer to import all markdown love in AEM.

Published in: Engineering
  • Be the first to comment

  • Be the first to like this

Aem markdown importer github love in aem

  1. 1. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. AEM Markdown Importer: GitHub Love in AEM Kanika Gera | Technical Product Manager | Adobe Systems
  2. 2. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 2 1 | Overview of AEM Markdown Importer 2 | AEM Markdown Importer: Import Process 3 | Using the markdown Importer 4 | Building & Contributing for markdown importer 5 | Q&A
  3. 3. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. AEM GitHub Let’s git the party started!
  4. 4. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Overview of AEM Markdown Importer
  5. 5. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 5 Why Use AEM Markdown Importer ?  Imports Markdown documents into AEM, creating an AEM content package on the go and make them searchable.  Content for websites powered on AEM can be easily generated without any authoring. No AEM Authoring expertise needed to leverage authoring functionalities like scheduled activation, versioning,  Easy to edit documents/code for technical writers/developers  Any markdown file can easily be published on AEM powered websites  Supports efforts of Open Source documentation
  6. 6. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 6 Overview of AEM Markdown Importer  Standalone markdown importer is a Java application distributed with jar file  Jar is executed to create AEM content package from markdown files (.md) stored on GitHub or local file system.  Generated content package can be deployed using package manager in AEM
  7. 7. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. AEM Markdown Importer Import Process:
  8. 8. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Developer Documentation Import Process: 8
  9. 9. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Publishing New/Updating API docs: 9
  10. 10. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Using the Markdown Importer
  11. 11. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 11 How to Use AEM Markdown Importer  Prerequisite: Java 8 or higher  Importer tool can be downloaded from artifactory or can be locally built  Source code can be checked out from https://github.com/adobe/aem-importer-markdown which is an Adobe Open Source Project
  12. 12. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 12 Running AEM ImporterTool: Run the tool - content package generated. Install the generated content package in AEM using the AEM package manager.  Configure theYAML file based on location of markdown docs in GitHub or locally
  13. 13. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 13 I. Configure the Importer:  All configuration happens in a .yaml file.  Configuration specifies where to find the Markdown files, where the content should be put in AEM and what kind of content should be created.  Can be configured to pull content either from corporate GitHub or local filesystem
  14. 14. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 14 a) Local Configuration (Import from Filesystem):
  15. 15. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 15 b) Corporate GitHub Configuration (Import from GitHub):
  16. 16. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 16 II. Run the Importer tool:  Configure the yml file  Run the importer with the following command:  java -jar importer-jar-with-dependencies.jar markdown2AEM.yml
  17. 17. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 17 III. Installing the AEM Package:  After execution of the tool, a package is generated.  Generated package, can be installed in AEM using the AEM package manager  Installed package, saves content in repository as jcr node.
  18. 18. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Building & Contributing to Markdown Importer:
  19. 19. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 19 Building the AEM markdown Importer  To use the application, check out this source code, then build with Maven: $ mvn clean package  If you are using Adobe's default settings.xml and you are outside of Adobe'sVPN, it is a good idea to disable the default profile: $ mvn clean package -P !artifactory-corp  You will end up with a file called target/importer-with-dependencies.jar.
  20. 20. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 20 Contributing to the AEM markdown Importer  Submit a pull request on the repository: https://github.com/adobe/aem-importer-markdown  File an issue: https://github.com/adobe/aem-importer-markdown/issues  Contribute a release: https://github.com/adobe/aem-importer-markdown#contributing
  21. 21. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Demo
  22. 22. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 22 DEMO:
  23. 23. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. References
  24. 24. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 24 References:  The documentation for the standalone markdown importer tool (which converts Markdown files to AEM): https://wiki.corp.adobe.com/pages/viewpage.action?spaceKey=AdobeCloudPlatform&title =Create+content+with+Standalone+Markdown+Importer  Code base is on https://github.com/adobe/aem-importer-markdown  The tool can be downloaded from: https://artifactory.corp.adobe.com/artifactory/webapp/#/artifacts/browse/tree/General/maven- markdown-tools-release
  25. 25. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Questions & Answers
  26. 26. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 26 AEM Markdown Importer FAQ’s &Tips:
  27. 27. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. Kanika Gera Twitter: @kanboss2002 LinkedIn: https://www.linkedin.com/in/kanikagera/
  28. 28. © 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.

×