adobe / aem-core-email-components

Apache License 2.0
13 stars 11 forks source link

Create readmes for every component based on GitHub wiki content #242

Closed bohnertchris closed 1 year ago

bohnertchris commented 1 year ago

Description

To bring the documentation of the Email Core Components in line with the Core Components, all content about the individual components in the GitHub wiki were moved to readme files for each component.

Related Issue

CQDOC-19486

Motivation and Context

Standardizes documentation across components projects so users can easily find content. Removes redundant and outdated content from GitHub wiki

How Has This Been Tested?

No. But only readme files were added.

Screenshots (if appropriate):

n/a

Types of changes

Checklist:

codecov[bot] commented 1 year ago

Codecov Report

Merging #242 (06e6335) into update-readmes (645c832) will increase coverage by 0.20%. The diff coverage is n/a.

@@                 Coverage Diff                  @@
##             update-readmes     #242      +/-   ##
====================================================
+ Coverage             83.98%   84.18%   +0.20%     
  Complexity              391      391              
====================================================
  Files                    27       27              
  Lines                  1180     1189       +9     
  Branches                214      215       +1     
====================================================
+ Hits                    991     1001      +10     
  Misses                   69       69              
+ Partials                120      119       -1     
Impacted Files Coverage Δ
...e/components/internal/models/SegmentationImpl.java 88.88% <0.00%> (ø)
...commons/editor/dialog/segmenteditor/Condition.java
...al/commons/editor/dialog/segmenteditor/Editor.java
...mmons/editor/dialog/segmenteditor/SegmentItem.java
...mmons/editor/dialog/segmenteditor/SegmentItem.java 90.00% <0.00%> (ø)
...re/commons/editor/dialog/segmenteditor/Editor.java 77.27% <0.00%> (ø)
...commons/editor/dialog/segmenteditor/Condition.java 100.00% <0.00%> (ø)
...internal/services/EmailLinkTransformerFactory.java 81.44% <0.00%> (+3.03%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

buuhuu commented 1 year ago

done within #244