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

Change to expath-pkg.xml abbrev breaks inbound links #181

Closed
joewiz opened this issue Feb 15, 2018 · 2 comments
Closed

Change to expath-pkg.xml abbrev breaks inbound links #181

joewiz opened this issue Feb 15, 2018 · 2 comments
Milestone

Comments

@joewiz
Copy link
Member

joewiz commented Feb 15, 2018

Where is the problem

<artifactId>exist-documentation</artifactId>

What is the problem

The generated app's expath-pkg.xml declares the package's @abbrev as exist-documentation. Apps such as fundocs expect the abbrev for eXist to be doc. (See eXist-db/function-documentation#19 (comment).)

Solutions: (1) Change artifactId from exist-documentation to doc. Or (2) Change references to this app from {doc} to {exist-documentation}. I prefer the former.

Please provide the following

  • exist-db version: 4.0.0
  • documentation version: 4.0.0
@joewiz
Copy link
Member Author

joewiz commented Feb 15, 2018

I believe this same phenomenon explains why the documentation app has been missing from the eXist installer since 3.6.0 despite being declared in https://github.com/eXist-db/exist/blob/develop/installer/apps.properties#L2. The actual contents of the 4.0.0 installer's autodeploy directory:

  • 00shared-resources-0.4.2.xar
  • dashboard-1.0.0.xar
  • eXide-2.4.3.xar
  • fundocs-0.9.xar
  • markdown-0.6.xar
  • monex-0.9.12.xar
  • usermanager-0.15.1-prod.xar

(eXist 3.5.1 shipped with doc-0.4.9.xar, the last release of the doc repo before the move to maven.)

@duncdrum duncdrum added the bug label Feb 15, 2018
@duncdrum duncdrum added this to the 4.0.1 milestone Feb 15, 2018
@duncdrum
Copy link
Contributor

duncdrum commented Feb 15, 2018

@joewiz I seem to remember that during a community call there was opposition to ship with the docs, the one on exist-db.org should be the canonical version. Installing via package-manager works fine for me.

As for the @abbrev that was fixed for outgoing links with #159 using the exist-app-parent by @adamretter.

Fixing incoming links via exist-app-parent, still needs to happen: See eXist-db/function-documentation#16, eXist-db/demo-apps#24, eXist-db/AtomicWiki#58

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