Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better aligning GitHub docs with archetype docs on Experience League #1117

Merged
merged 14 commits into from Jan 25, 2024

Conversation

bohnertchris
Copy link
Contributor

@bohnertchris bohnertchris commented Aug 7, 2023

Description

There is currently a lot of overlap and redundancy in the documentation for the archetype within the readmes of this repository and that on Experience League (https://experienceleague.adobe.com/docs/experience-manager-core-components/using/developing/archetype/overview.html).

This PR and another in the Core Components documentation repo aims to limit the documentation on Experience League to a usage overview and general information about the archetype while all technical details remain in the GitHub readmes.

Related Issue

CQDOC-20146
PR # 262 on the experience-manager-core-components.en corporate repo

Motivation and Context

With this change, updates to the archetype only need to be updated in the readmes, minimizing the possibility of inconsistencies arising in the two documentation sources. It also makes it clearer to the user what is documented where.

How Has This Been Tested?

No. I only made changes to readmes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

bohnertchris and others added 2 commits August 7, 2023 16:17
From @davidjgonzalez

Co-authored-by: david g. <davidjgonzalez@users.noreply.github.com>
From @davidjgonzalez

Co-authored-by: david g. <davidjgonzalez@users.noreply.github.com>
@bohnertchris bohnertchris merged commit fea9c0e into adobe:develop Jan 25, 2024
9 checks passed
@bohnertchris bohnertchris deleted the CQDOC-20146 branch January 25, 2024 08:05
@Buuhuu Buuhuu added this to the 48 milestone Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants