Improve README files - Githubissues

adobe / aem-spa-project-archetype

Maven Archetype for creating new AEM SPA projects

Apache License 2.0

61 stars 32 forks source link

Improve README files #119

Closed samuelmeuli closed 4 years ago

samuelmeuli commented 4 years ago

Q	A
Fixed Issues?	–
Patch: Bug Fix?	No
Minor: New Feature?	No
Major: Breaking Change?	No
Tests Added + Pass?	No
Documentation Provided	No
Any Dependency Changes?	No
License	Apache License, Version 2.0

Improved the README files throughout the project:

Removed duplicate content and clearly separated what's described where: Archetype information in the root file, AEM project information in the root of generated projects, and framework-specific information in the angular-app/react-app directories
Simplified some commands and usage instructions so people can get started with the project more quickly
Added links to the documentation files
Used consistent formatting

habansal commented 4 years ago

While you are working on it, Can you also fix text in Contributing.md. I think it was copied from the Core components project and has a left-over :

We strongly encourage users of the Core Components to bring their own project experience to these issues, as there may be alternative use-cases or requirements that haven't yet been considered.

It should be removed.

See https://github.com/adobe/aem-spa-project-archetype/blob/master/CONTRIBUTING.md#joining-feature-discussions-

habansal commented 4 years ago

If you see this page - https://github.com/samuelmeuli/aem-spa-project-archetype/tree/readmes/src/main/resources/archetype-resources

You see stuff like - #set($hash = '#') ${hash} AEM SPA Project ${hash}${hash} Modules

I don't think that's intended, right ? If not, can you fix it ?

samuelmeuli commented 4 years ago

While you are working on it, Can you also fix text in Contributing.md.

Ok, I'll update that.

I don't think that's intended, right ?

It is intended. # seems to be a reserved character with Maven, and the README files get corrupted if we don't do this. This is the same approach as in aem-project-archetype.

Also, aem-project-archetype doesn't have a CHANGELOG.md file, but has that information in the Releases tab. We're currently doing both. Would you be okay with following the same approach and removing the file?