Skip to content

Commit

Permalink
more code quality cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@wwelling
wwelling committed May 27, 2019
1 parent 9749e6a commit 20dd8be
Show file tree
Hide file tree
Showing 10 changed files with 142 additions and 152 deletions.
51 changes: 22 additions & 29 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,30 @@ Though IR IIIF Service is developed and maintained by Texas A&M University Libra
#### Using IR IIIF Service

Deploying IR IIIF Service and trying it out at your own institution is itself a way of contributing to the development process. For more information on deployment strategies please see the [relevant documentation](https://github.com/TAMULib/IRIIIFService/blob/master/README.md).

#### Filing Issues

Once you are using IR IIIF Service the creation of new issues through Github is a major method of contribution towards IR IIIF Service development. Issues can be motivated by the discovery of a bug in the software, or by the desire to see either new features added to cap or existing features behaving differently.

These three categories of issue can be submitted using the following template:

```
[*] Bug Report
[] Feature Enhancement
[] Feature Request
Current Behavior:
[*] Bug Report
[] Feature Enhancement
[] Feature Request

[A description of the current behavior. This could include a list of steps to reproduce in the instance of a
Bug Report, and can be 'N/A' for Feature Requests]
Current Behavior:

Desired Behavior:
[A description of the current behavior. This could include a list of steps to reproduce in the instance of a
Bug Report, and can be 'N/A' for Feature Requests]

[A description of the expected/desired behavior of the application]
Desired Behavior:

[A description of the expected/desired behavior of the application]

Relevant Information:

[This section can include relevant error messages, or links to information that pertains to the issue]
Relevant Information:

```
[This section can include relevant error messages, or links to information that pertains to the issue]

Once an issue has been filed it will be curated by a IR IIIF Service developer and receive the appropriate labeling.

Expand All @@ -45,32 +42,28 @@ A PR description should include a list of the specific issues resolved, the pred

For more information about semantic versioning please see [this reference](https://semver.org/). In general keep in mind:

- A Major Change is a breaking change that is not backwards compatible.
- A Minor Change is a non breaking change that is backwards compatible to the last major change.
- A Patch is a trivial change or bug fix that should not impact compatibility
- A Major Change is a breaking change that is not backwards compatible.
- A Minor Change is a non breaking change that is backwards compatible to the last major change.
- A Patch is a trivial change or bug fix that should not impact compatibility

Please confirm you PR description to the following template:

```
Resolves:
Resolves:

- [List of # references to specific issues addressed by this PR]
- [List of # references to specific issues addressed by this PR]

Changes:
Changes:

[*] Major
[] Minor
[] Patch
[*] Major
[] Minor
[] Patch

[A description of the approach taken to resolving those issues]
```
[A description of the approach taken to resolving those issues]

In addition to a well formatted PR we would also appreciate granular commits with descriptive messages. For instance a good commit message may be `Moved /foo endpoint logic into a FooService`, whereas `Everything I did Friday` is less granular or descriptive.

If your commits do not conform to these recommendations you might consider rebasing your PR. Instructions for how this might work can be found [here](https://help.github.com/articles/about-git-rebase/).


#### Good Luck!

We look forward to seeing your contributions. If you have any additional questions please contact the IR IIIF Service developers at [helpdesk@library.tamu.edu]().
We look forward to seeing your contributions. If you have any additional questions please contact the IR IIIF Service developers at [helpdesk@library.tamu.edu](<>).
75 changes: 37 additions & 38 deletions DEPLOYING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ IR IIIF Service build is done with [Maven](https://maven.apache.org/). The build

### Maven build arguments

* ```-DskipTests``` will skip tests.
* ```-Dspring.config.location=file:/var/ir-iiif-service/config/``` will configure the external configuration directory for development using `spring-boot:run`.
- `-DskipTests` will skip tests.
- `-Dspring.config.location=file:/var/ir-iiif-service/config/` will configure the external configuration directory for development using `spring-boot:run`.

**Ending trailing slash is required for spring.config.location**

Expand Down Expand Up @@ -50,40 +50,40 @@ $ mvn clean test

<br/>

| **Property** | **Type** | **Description** | **Example** |
| :----------- | :------- | :-------------- | :---------- |
| server.contextPath | string | Path in which service is hosted. | /iiif-service |
| server.port | number | Port in which service is hosted. | 9000 |
| logging.file | string | Log file. | iiif-service.log |
| logging.level.edu.tamu.iiif | LOG_LEVEL | Log level for iiif service. | INFO |
| logging.level.org.springframework | LOG_LEVEL | Log level for spring framework. | INFO |
| logging.path | string | Path for log file. | /var/logs/iiif |
| spring.activemq.broker-url | url | ActiveMQ broker URL. | tcp://localhost:61616 |
| spring.activemq.username | string | ActiveMQ broker username. | username |
| spring.activemq.password | string | ActiveMQ broker password. | password |
| spring.redis.host | string | Host for redis server. | localhost |
| spring.redis.port | number | Port for redis server. | 6379 |
| spring.profiles.active | string | Build environment profile. | production |
| spring.profiles.include | string | Additional build environment profiles. | dspace, fedora, weaver-messaging |
| messaging.channels.cap | string | Channel to listen for Weaver messages in order to update chached manifests. | cap |
| iiif.admins | object array | Array of admin credentials. | [ { username: admin, password: password } ] |
| iiif.service.url | url | IIIF service URL. | http://localhost:${server.port}${server.contextPath} |
| iiif.service.connection.timeout | number | HTTP connection request timeout in milliseconds. | 300000 |
| iiif.service.connection.request.timeout | number | HTTP connection timeout in milliseconds. | 300000 |
| iiif.service.socket.timeout | number | HTTP socket timeout in milliseconds. | 300000 |
| iiif.image.server.url | url | IIIF image server URL. | http://localhost:8182/iiif/2 |
| iiif.logo.url | url | URL for a default logo. | https://localhost/assets/downloads/logos/Logo.png |
| iiif.dspace.identifier | string | DSpace Identifier. | dspace |
| iiif.dspace.label-precedence | array | Array of valid RDF schema fields to determine title. | [ "http://purl.org/dc/elements/1.1/title", "http://purl.org/dc/terms/title" ] |
| iiif.dspace.description-precedence | array | Array of valid RDF schema fields to determine description. | [ "http://purl.org/dc/terms/abstract", "http://purl.org/dc/terms/description" ] |
| iiif.dspace.metadata-prefixes | array | Array of valid RDF schema URL to determine what metadate to include. | [ "http://purl.org/dc/elements/1.1/", "http://purl.org/dc/terms/" ] |
| iiif.dspace.url | url | DSpace base URL. | http://localhost:8080 |
| iiif.dspace.webapp | string | DSpace UI webapp. | xmlui |
| iiif.fedora.identifier | string | Fedora PCDM identifier. | fedora |
| iiif.fedora.url | url | Fedora REST URL. | http://localhost:9000/fcrepo/rest |
| iiif.dspace.label-precedence | array | Array of valid RDF schema fields to determine title. | [ "http://purl.org/dc/elements/1.1/title", "http://purl.org/dc/terms/title" ] |
| iiif.fedora.description-precedence | array | Array of valid RDF schema fields to determine description. | [ "http://purl.org/dc/terms/abstract", "http://purl.org/dc/terms/description" ] |
| iiif.fedora.metadata-prefixes | array | Array of valid RDF schema URL to determine what metadate to include. | [ "http://purl.org/dc/elements/1.1/", "http://purl.org/dc/terms/" ] |
| **Property** | **Type** | **Description** | **Example** |
| :-------------------------------------- | :----------- | :-------------------------------------------------------------------------- | :------------------------------------------------------------------------------ |
| server.contextPath | string | Path in which service is hosted. | /iiif-service |
| server.port | number | Port in which service is hosted. | 9000 |
| logging.file | string | Log file. | iiif-service.log |
| logging.level.edu.tamu.iiif | LOG_LEVEL | Log level for iiif service. | INFO |
| logging.level.org.springframework | LOG_LEVEL | Log level for spring framework. | INFO |
| logging.path | string | Path for log file. | /var/logs/iiif |
| spring.activemq.broker-url | url | ActiveMQ broker URL. | tcp://localhost:61616 |
| spring.activemq.username | string | ActiveMQ broker username. | username |
| spring.activemq.password | string | ActiveMQ broker password. | password |
| spring.redis.host | string | Host for redis server. | localhost |
| spring.redis.port | number | Port for redis server. | 6379 |
| spring.profiles.active | string | Build environment profile. | production |
| spring.profiles.include | string | Additional build environment profiles. | dspace, fedora, weaver-messaging |
| messaging.channels.cap | string | Channel to listen for Weaver messages in order to update chached manifests. | cap |
| iiif.admins | object array | Array of admin credentials. | [ { username: admin, password: password } ] |
| iiif.service.url | url | IIIF service URL. | <http://localhost:${server.port}${server.contextPath}> |
| iiif.service.connection.timeout | number | HTTP connection request timeout in milliseconds. | 300000 |
| iiif.service.connection.request.timeout | number | HTTP connection timeout in milliseconds. | 300000 |
| iiif.service.socket.timeout | number | HTTP socket timeout in milliseconds. | 300000 |
| iiif.image.server.url | url | IIIF image server URL. | <http://localhost:8182/iiif/2> |
| iiif.logo.url | url | URL for a default logo. | <https://localhost/assets/downloads/logos/Logo.png> |
| iiif.dspace.identifier | string | DSpace Identifier. | dspace |
| iiif.dspace.label-precedence | array | Array of valid RDF schema fields to determine title. | [ "http://purl.org/dc/elements/1.1/title", "http://purl.org/dc/terms/title" ] |
| iiif.dspace.description-precedence | array | Array of valid RDF schema fields to determine description. | [ "http://purl.org/dc/terms/abstract", "http://purl.org/dc/terms/description" ] |
| iiif.dspace.metadata-prefixes | array | Array of valid RDF schema URL to determine what metadate to include. | [ "http://purl.org/dc/elements/1.1/", "http://purl.org/dc/terms/" ] |
| iiif.dspace.url | url | DSpace base URL. | <http://localhost:8080> |
| iiif.dspace.webapp | string | DSpace UI webapp. | xmlui |
| iiif.fedora.identifier | string | Fedora PCDM identifier. | fedora |
| iiif.fedora.url | url | Fedora REST URL. | <http://localhost:9000/fcrepo/rest> |
| iiif.dspace.label-precedence | array | Array of valid RDF schema fields to determine title. | [ "http://purl.org/dc/elements/1.1/title", "http://purl.org/dc/terms/title" ] |
| iiif.fedora.description-precedence | array | Array of valid RDF schema fields to determine description. | [ "http://purl.org/dc/terms/abstract", "http://purl.org/dc/terms/description" ] |
| iiif.fedora.metadata-prefixes | array | Array of valid RDF schema URL to determine what metadate to include. | [ "http://purl.org/dc/elements/1.1/", "http://purl.org/dc/terms/" ] |

</details>

Expand All @@ -100,7 +100,6 @@ Currently, in order to have Tomcat know where the external configuration directo

2) Update [application.yml](https://github.com/TAMULib/IRIIIFService/blob/master/src/main/resources/application.yml)


### Deploy to Tomcat

Copy war file into Tomcat webapps directory (your location may vary -- this is an example):
Expand All @@ -111,7 +110,7 @@ $ cp ~/ROOT.war /opt/tomcat/webapps/ir-iiif-service.war

**if not specifying config.uri during build the application.yml will be under the IR IIIF Service webapp's classpath, /opt/tomcat/webapps/ir-iiif-service/WEB-INF/classes/application.yml**

**if deployed from default WAR package and would like to externalize the config, you will have to edit /opt/tomcat/webapps/ir-iiif-service/META-INF/context.xml***
**if deployed from default WAR package and would like to externalize the config, you will have to edit /opt/tomcat/webapps/ir-iiif-service/META-INF/context.xml\***

### Running WAR as a stand-alone Spring Boot application

Expand Down
Loading

0 comments on commit 20dd8be

Please sign in to comment.