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

Let's delete all of the sample cruft #462

Open
jpotts opened this issue Apr 24, 2017 · 10 comments
Open

Let's delete all of the sample cruft #462

jpotts opened this issue Apr 24, 2017 · 10 comments

Comments

@jpotts
Copy link
Contributor

jpotts commented Apr 24, 2017

The amount of sample files has increased significantly in SDK 3.0.0.

If these files are here to help beginners, this is a bad place for them. We could instead establish a separate "sample project" archetype or something.

If these files are here to support testing of the SDK, could we at least trim them back?

I use the archetype every time I create a new project, which is quite often. I was mildly annoyed by having to delete the sample Java beans before SDK 3.0.0. Now the effort it takes to get rid of all the sample cruft is a lot greater.

I'm happy to do the work of cleaning this up if I know you'll accept the pull request.

@douglascrp
Copy link
Contributor

And what is worst, if you don't know about them, or forget about them, you will end up having things you don't really need.

I agree on @jpotts idea about having a separated archetype for sample.

@ladenberger
Copy link

+1

@jgoldhammer
Copy link
Contributor

jgoldhammer commented Apr 27, 2017 via email

@binduwavell
Copy link

binduwavell commented May 7, 2017

Yeoman generator has this as an option. Now I need to add SDK 3 support ;)

@ohej
Copy link
Contributor

ohej commented Jun 23, 2017

Thanks for the feedback, and the offer to help clean it up.

I agree that it's about time we address this, however we need to consider an approach where people can still get a sample project up and running. One common question or concern is "Where do I put my stuff?" - having the sample code and config addresses this.

This could easily be dealt with leveraging the Yeoman generator, or simply get the alfresco-sdk-samples project updated, or just build a zip file with everything and update it on every release.

The major issue I see here is that both Git and Maven Archetypes are notorious for handling empty directories. We may end up having to have at least one file per directory to ensure the directory structure will be created when generating a new project.

With all that being said, I'm giving a +1 to this, however I am not sure we can do this in the 3.0 release as it would efficiently introduce breaking changes - but it is a bit in a grey area.

@jpotts
Copy link
Contributor Author

jpotts commented Jun 23, 2017 via email

@jpotts
Copy link
Contributor Author

jpotts commented Apr 20, 2018

I just helped another new Alfresco SDK user learn how to comb through his SDK project deleting sample files. So I popped in to see where we are on this.

I do like that the Yeoman generator has this option and that tool is useful, but there are people who would be reluctant to add node and npm to their build stack only for this.

Looks like we have a bunch of +1's and no one saying this should not be done. So how about it?

@binduwavell
Copy link

Don't need node and npm in build stack, only on dev machine when you create project.

@jpotts
Copy link
Contributor Author

jpotts commented Sep 9, 2021

Why did this get closed? Are you deleting all the sample cruft from the SDK?

@andrea-ligios
Copy link
Member

Thank you @jpotts, it got closed by mistake along with other old/stale issues as part of a housekeeping operation.

Let's reopen it, it makes sense and it might be addressed at a certain point.

@andrea-ligios andrea-ligios reopened this Sep 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants