-
-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
As proposed in #96: - Adopt conventions for app name and version properties - Add release notes describing which articles had improvements and what those improvements were (drawn from commit history) so users know what to look out for - Add github repo as repo website link - Revise note shown during upgrade to indicate it is only a concern for eXist 2.x users - Improve README
- Loading branch information
Showing
6 changed files
with
45 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
build/ | ||
expath-pkg.xml | ||
*.xpr | ||
local.build.properties |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,20 @@ | ||
eXist-db / documentation | ||
============= | ||
eXist-db Documentation | ||
====================== | ||
|
||
This is the (official) documentation project for the eXist-db Natice XML database. | ||
This repository contains the official documentation for the eXist-db Native XML database and the application for browsing it. | ||
|
||
The documentation is deployed as an XAR file. The XAR file is built with "ant": | ||
## Resources | ||
|
||
``` | ||
ant | ||
Buildfile: /Users/myhome/GitHub/documentation/build.xml | ||
- Browse the latest release of the documentation at http://exist-db.org/exist/apps/doc/. | ||
- The documentation app is included by default in the eXist-db installer. Just go to your eXist server's Dashboard and select Documentation. | ||
- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at <http://exist-db.org/exist/apps/public-repo/>. | ||
|
||
xar: | ||
[copy] Copying 1 file to /Users/myhome/GitHub/documentation | ||
[zip] Building zip: /Users/myhome/GitHub/documentation/build/doc-0.3.3.xar | ||
## Building from source | ||
|
||
all: | ||
BUILD SUCCESSFUL | ||
Total time: 1 second | ||
``` | ||
|
||
Contributions are very welcome using the GitHub Pull Request mechanism. | ||
|
||
The documentation is accessible via http://exist-db.org/exist/apps/doc/ ; A pre-built version can be obtained via the eXist-db package manager or via the public App Repository http://exist-db.org/exist/apps/public-repo/ | ||
- Dependencies: Apache Ant, eXist 2.2+ | ||
- Clone the repository to your system | ||
- From the command line, call `ant` | ||
- An EXPath Application Package (.xar file) is deposited in the `build` directory | ||
- Install this file via the Dashboard > Package Manager. | ||
|
||
Find an area of the documentation that needs to be improved? Please raise an issue and submit a pull request! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# | ||
# Don't directly modify this file. Instead, copy it to local.build.properties and | ||
# edit that. | ||
# | ||
|
||
project.name=doc | ||
project.version=0.4.8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<package xmlns="http://expath.org/ns/pkg" name="http://exist-db.org/apps/doc" abbrev="doc" version="@project.version@" spec="1.0"> | ||
<package xmlns="http://expath.org/ns/pkg" name="http://exist-db.org/apps/doc" abbrev="@project.name@" version="@project.version@" spec="1.0"> | ||
<title>eXist-db Documentation</title> | ||
<dependency package="http://exist-db.org/apps/shared" semver-min="0.4.0"/> | ||
</package> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters