Skip to content

Commit

Permalink
Update documentation to reflect the newest JPA test model path (#153)
Browse files Browse the repository at this point in the history
  • Loading branch information
QubitPi authored May 7, 2024
1 parent 772bd5c commit 735b891
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 61 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ env:
EMAIL: jack20220723@gmail.com

jobs:
mk-yml-style-check:
uses: QubitPi/hashicorp-aws/.github/workflows/yml-and-md-style-checks.yml@master
yml-md-style-and-link-checks:
uses: QubitPi/hashicorp-aws/.github/workflows/yml-md-style-and-link-checks.yml@master

tests:
name: Unit & Integration Tests
needs: mk-yml-style-check
needs: yml-md-style-and-link-checks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
3 changes: 3 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
file:///*
https://querydsl.com/*
https://uel.java.net/
2 changes: 0 additions & 2 deletions .mdlrc

This file was deleted.

26 changes: 0 additions & 26 deletions .yamllint

This file was deleted.

8 changes: 4 additions & 4 deletions docs/docs/elide/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The IT tests will run against an [example model] so make sure the following envi
model:

```bash
export TEST_MODEL_PACKAGE_NAME=com.qubitpi.ws.jersey.template.models
export TEST_MODEL_PACKAGE_NAME=io.github.qubitpi.ws.jersey.template.models
```

<!-- markdown-link-check-disable -->
Expand Down Expand Up @@ -81,11 +81,11 @@ cp settings.xml.example ~/.m2/settings.xml
<profile>
<id>data-models</id>
<properties>
<model.package.jar.group.id>com.qubitpi</model.package.jar.group.id>
<model.package.jar.group.id>io.github.qubitpi</model.package.jar.group.id>
<model.package.jar.artifact.id>
jersey-webservice-template-jpa-data-models
</model.package.jar.artifact.id>
<model.package.jar.version>1.0.0</model.package.jar.version>
<model.package.jar.version>1.0.1</model.package.jar.version>
</properties>
</profile>
</profiles>
Expand Down Expand Up @@ -422,7 +422,7 @@ export class Client {
[Elide instance class]: https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/Elide.java
[Elide Standalone]: https://github.com/yahoo/elide/tree/master/elide-standalone
[ElideSettings instance class]: https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/ElideSettings.java
[example model]: https://github.com/QubitPi/jersey-webservice-template-jpa-data-models/blob/master/src/main/java/com/qubitpi/ws/jersey/template/models/Book.java
[example model]: https://github.com/QubitPi/jersey-webservice-template-jpa-data-models/blob/master/src/main/java/io/github/qubitpi/ws/jersey/template/models/Book.java

[jcabi-mysql]: https://mysql.jcabi.com/

Expand Down
13 changes: 6 additions & 7 deletions docs/docs/elide/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Please visit [JWT GitHub] and either
1. clone the repo with `git clone https://github.com/QubitPi/jersey-webservice-template.git`, or
2. make it a template instantiation with our own webservice name by doing the following:

![Error loading instantiation-1.png](./img/instantiation-1.png)
![Error loading instantiation-2.png](./img/instantiation-2.png)
![Error loading instantiation-1.png](./img/instantiation-1.png)
![Error loading instantiation-2.png](./img/instantiation-2.png)

Creating Models
---------------
Expand Down Expand Up @@ -111,9 +111,9 @@ load [data models](#creating-models) via Maven config file, i.e. **~/.m2/setting
<profile>
<id>jwt-data-models</id>
<properties>
<model.package.jar.group.id>com.qubitpi</model.package.jar.group.id>
<model.package.jar.group.id>io.github.qubitpi</model.package.jar.group.id>
<model.package.jar.artifact.id>jersey-webservice-template-jpa-data-models</model.package.jar.artifact.id>
<model.package.jar.version>1.0.0</model.package.jar.version>
<model.package.jar.version>1.0.1</model.package.jar.version>
</properties>
</profile>
</profiles>
Expand All @@ -132,12 +132,12 @@ With data models defined, can run _my-webservice_
```bash
cd my-webservice
mvn clean package
MODEL_PACKAGE_NAME=com.qubitpi.ws.jersey.template.models docker compose up --build --force-recreate
MODEL_PACKAGE_NAME=io.github.qubitpi.ws.jersey.template.models docker compose up --build --force-recreate
```

:::info

`com.qubitpi.ws.jersey.template.models` is the name of the model in the aforementioned
`io.github.qubitpi.ws.jersey.template.models` is the name of the model in the aforementioned
[data model project][jersey-webservice-template-jpa-data-models]

:::
Expand Down Expand Up @@ -309,4 +309,3 @@ our users is just as easy as it is to add new data. Let's update our model with
[JWT GitHub]: https://github.com/QubitPi/jersey-webservice-template
[jersey-webservice-template-jpa-data-models]: https://github.com/QubitPi/jersey-webservice-template-jpa-data-models
19 changes: 0 additions & 19 deletions markdownlint.rb

This file was deleted.

0 comments on commit 735b891

Please sign in to comment.