diff --git a/.lycheeignore b/.lycheeignore index 2d0f39fb..39c854fd 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -1,3 +1,4 @@ file:///* https://querydsl.com/* https://uel.java.net/ +https://www.openapis.org/ diff --git a/README.md b/README.md index 796b50ac..430c0d44 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Documentation JWT supports 3 kinds of webservice templates: - [A general scaffolding without any vertical-business logics](https://qubitpi.github.io/jersey-webservice-template/docs/intro) -- [A JPA webservice template backed by yahoo/elide](https://qubitpi.github.io/jersey-webservice-template/docs/elide/intro) +- [A JPA webservice template backed by yahoo/elide](https://qubitpi.github.io/jersey-webservice-template/docs/crud/) - An async jobstore webservice template similar to yahoo/fili's JobStore design (Developing...) Comprehensive documentation is viewable on our [website][Documentation] diff --git a/docs/docs/crud/img/instantiation-2.png b/docs/docs/crud/img/instantiation-2.png index df3b8591..5ecd4c57 100644 Binary files a/docs/docs/crud/img/instantiation-2.png and b/docs/docs/crud/img/instantiation-2.png differ diff --git a/docs/docs/crud/index.mdx b/docs/docs/crud/index.mdx index 45074af8..6aeb8cd5 100644 --- a/docs/docs/crud/index.mdx +++ b/docs/docs/crud/index.mdx @@ -24,10 +24,18 @@ Instantiating the Template Please visit [JWT GitHub] and either -1. clone the repo with `git clone https://github.com/QubitPi/jersey-webservice-template.git`, or +1. clone the repo with `git clone https://github.com/QubitPi/jersey-webservice-template.git` and switch to the + `jpa-elide` branch using `git checkout jpa-elide`, 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) + + :::note + + Please make sure the "__Include all branches__" is checked + + ::: + ![Error loading instantiation-2.png](./img/instantiation-2.png) Creating Models @@ -71,7 +79,8 @@ In the end, run `mvn clean install` to install our model :::info -From this point on, we assume [this example data model][jersey-webservice-template-jpa-data-models] is used +From this point on, we assume [this example data model][jersey-webservice-template-jpa-data-models] is used, which can +be installed locally using the following commands: ```bash git clone https://github.com/QubitPi/jersey-webservice-template-jpa-data-models.git @@ -85,7 +94,7 @@ Loading Data Models ------------------- So now we have some models, but without an API it is not very useful. Now we need to instruct our _my-webservice_ to -load [data models](#creating-models) via Maven config file, i.e. **~/.m2/settings.xml**: +load [data models](#creating-models) via Maven config file, i.e. __settings.xml__: ```xml