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

First impressions #2

Open
7 of 9 tasks
duncdrum opened this issue Jan 3, 2018 · 1 comment
Open
7 of 9 tasks

First impressions #2

duncdrum opened this issue Jan 3, 2018 · 1 comment

Comments

@duncdrum
Copy link
Contributor

duncdrum commented Jan 3, 2018

  • the four prompt values groupId, artifactId, version, package are somewhat at odds with the naming conventions of eXist's repo.xml, expath-pkg.xml values. Make it easier for folks to understand what is what in the new maven hotness by adding some prose to readme.md or by changing the name of the prompts:
archetype groupId artifactId version package
repo website (description) version website
expath-pkg package@name package@abbrev package@version package@name
  • once installed the index.html of the example app isn't reachable from either the package-manager or dashboard. This is at odds with apps generated by eXide, or tei-publisher. Something isn't quite right with the generated controller.xql (actually i think this is because of the differences between repo and expath-pkg with respect to the app title, s.a.)
  • the app uses the default documentation icon.png instead of the default app icon, let's use either the default of give it its own?
  • change collection name from content to modules as the conventional place to store xquery modules
  • explain: cxan.xml,
  • explain: exist.xml, components.xml since they are specific to archetype generated apps and not part of the standard apps template
  • let's generate a preconfigured .gitignore that excludes /target since the archetype needs git anyways
  • eXide apps only know alpha, beta, stable as status let's either add SNAPSHOT to eXide, or switch the name in the archetype?
  • the apps are missing an author (which should also appear in the LICENSE file)
@adamretter
Copy link
Member

I have just released a new version: 1.1. It will appear on Maven Central and be generally available within the next 2 hours.

the four prompt values groupId, artifactId, version, package are somewhat at odds with the naming conventions of eXist's repo.xml, expath-pkg.xml values. Make it easier for folks to understand what is what...

I have updated the README.md.

once installed the index.html of the example app isn't reachable from either the package-manager or dashboard....

We were missing <target> from the generated repo.xml. I have now fixed that.

the app uses the default documentation icon.png instead of the default app icon, let's use either the default of give it its own?

It now has a custom "App" icon.

change collection name from content to modules as the conventional place to store xquery modules

the content folder is a convention of the EXPath spec for library modules written in Java or XQuery that should be installed into the database. You will note the other resources (XQuery's included) can be placed anywhere under xar-resources.

explain: cxan.xml, exist.xml, components.xml since they are specific to archetype generated apps and not part of the standard apps template

I think that should instead be part of the eXist-db documentation.

eXide apps only know alpha, beta, stable as status let's either add SNAPSHOT to eXide, or switch the name in the archetype?

eXide should be updated to support SNAPSHOT.

the apps are missing an author (which should also appear in the LICENSE file)

It is present in the both cxan.xml and repo.xml. eXist should pick that up I think.

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

No branches or pull requests

2 participants