Skip to content

Commit c27d459

Browse files
authored
Merge pull request #166 from eXist-db/readme-fix
fix directory name...
2 parents c8feed3 + 85f7046 commit c27d459

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ Found an area of the documentation that needs to be improved? Please raise an [i
2222

2323
Our test-suite performs a validation check on all articles when you open a pull request. You can speed up the review process by running `mvn validate` locally before submitting a pull request.
2424

25-
Should you encounter documentation for features that are deprecated in the minimum eXist-db version mentioned [above](#dependencies), you can simply delete them. If you are unsure about this, please open an [issue](https://github.com/eXist-db/documentation/issues).
25+
Should you encounter documentation for features that are deprecated in the minimum eXist-db version mentioned [above](#dependencies), you can simply delete them. If you are unsure about this, please open an [issue](https://github.com/eXist-db/documentation/issues).
2626

2727
## Building from source
2828
1. Clone the repository to your system:
2929
```bash
30-
$ git clone https://github.com/exist-db/documentation.git exist-documentation
30+
$ git clone https://github.com/exist-db/documentation.git documentation
3131
```
3232

3333
2. Build the documentation application:
3434
```bash
35-
$ cd exist-documentation
35+
$ cd documentation
3636
$ mvn clean package
3737
```
3838
The compiled `.xar` file is located in the `/target` directory

RELEASE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,27 @@ Core-contributors should follow these steps when publishing a new release of the
66
```bash
77
gpg --list-keys
88
```
9+
10+
- maven also requires a nexus account. You can create one at [oss.sonatype.org](https://oss.sonatype.org/#welcome) and include your credentials in your maven's `settings.xml` (replacing username and password):
11+
12+
```xml
13+
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
14+
<servers>
15+
<server>
16+
<id>sonatype-nexus-snapshots</id>
17+
<username>USERNAME</username>
18+
<password>PASSWORD</password>
19+
</server>
20+
<server>
21+
<id>sonatype-nexus-staging</id>
22+
<username>USERNAME</username>
23+
<password>PASSWORD</password>
24+
</server>
25+
</servers>
26+
</settings>
27+
```
28+
29+
930
- You can perform a dry-run of the release procedure by executing
1031
```bash
1132
$ mvn -DdryRun=true release:prepare

0 commit comments

Comments
 (0)