Update README (#176)

QubitPi · Sep 30, 2024 · b1024e6 · b1024e6
1 parent 944ecad
commit b1024e6
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,10 @@
-Jersey Webservice Template <sup>![Java Version Badge][Java Version Badge]</sup>
-===============================================================================
+Jersey Webservice Template
+==========================
 
+[Java Version Badge][Java Version Badge]
 [![GitHub Workflow Status][GitHub Workflow Status]](https://github.com/QubitPi/jersey-webservice-template/actions/workflows/ci-cd.yml)
 ![Last Commit](https://img.shields.io/github/last-commit/QubitPi/jersey-webservice-template/master?logo=github&style=for-the-badge)
-[![Apache License Badge]](https://www.apache.org/licenses/LICENSE-2.0)
-![GitHub Actions Badge][GitHub Actions Badge]
-![HashiCorp Packer Badge][HashiCorp Packer Badge]
-![HashiCorp Terraform Badge][HashiCorp Terraform Badge]
+[![Apache License Badge]][Apache License, Version 2.0]
 
 [Jersey Webservice Template (JWT)][jersey-webservice-template] is a [JSR 370] web service **template** that lets us
 spin up Java web service quickly through [Golden Paths] approach.
@@ -41,29 +39,18 @@ Comprehensive documentation is viewable on our [website][Documentation]
 License
 -------
 
-The use and distribution terms for [jersey-webservice-template] are covered by the
-[Apache License, Version 2.0][Apache License, Version 2.0].
-
-<div align="center">
-    <a href="https://opensource.org/licenses">
-        <img align="center" width="50%" alt="License Illustration" src="https://github.com/QubitPi/QubitPi/blob/master/img/apache-2.png?raw=true">
-    </a>
-</div>
+The use and distribution terms for [jersey-webservice-template] are covered by the [Apache License, Version 2.0].
 
 [Apache License Badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white
-[Apache License, Version 2.0]: http://www.apache.org/licenses/LICENSE-2.0.html
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
 
 [Documentation]: https://qubitpi.github.io/jersey-webservice-template/
 
 [How to set up GitHub Action Secrets]: https://docs.github.com/en/actions/security-guides/encrypted-secrets
 
-[GitHub Actions Badge]: https://img.shields.io/badge/GitHub%20Actions-2088FF?style=for-the-badge&logo=githubactions&logoColor=white
 [GitHub Workflow Status]: https://img.shields.io/github/actions/workflow/status/QubitPi/jersey-webservice-template/ci-cd.yml?branch=master&logo=github&style=for-the-badge
 [Golden Paths]: https://www.hashicorp.com/blog/maturing-your-terraform-workflow#golden-paths
 
-[HashiCorp Packer Badge]: https://img.shields.io/badge/Packer-02A8EF?style=for-the-badge&logo=Packer&logoColor=white
-[HashiCorp Terraform Badge]: https://img.shields.io/badge/Terraform-7B42BC?style=for-the-badge&logo=terraform&logoColor=white
-
 [Java Version Badge]: https://img.shields.io/badge/Java-17-brightgreen?style=for-the-badge&logo=OpenJDK&logoColor=white
 [Javadoc]: https://qubitpi.github.io/jersey-webservice-template/apidocs/
 [jersey-webservice-template]: https://qubitpi.github.io/jersey-webservice-template/

diff --git a/docs/blog/2020-08-28-oracle-programming/index.md b/docs/blog/2020-08-28-oracle-programming/index.md
@@ -33,32 +33,6 @@ exit | sqlplus -S $user/$pwd@//$server:$port/$service_name @script.sql
 One example value of `$service_name` could be "ORCL". Note that there is a `@` symble preceding the script
 path(`script.sql`)
 
-### Connecting to Oracle DB Instance From the Command Line
-
-#### (First Time) Install Oracle Instant Client and sqlplus using Homebrew
-
-1. Download the two files below from [here](http://www.oracle.com/technetwork/topics/intel-macsoft-096467.html). This
-   is necessary because of Oracle licenses:
-
-   - `instantclient-basic-macos.x64–<version>.zip`
-   - `instantclient-sqlplus-macos.x64–<version>.zip`
-
-2. Run
-
-```bash
-brew tap InstantClientTap/instantclient
-brew install instantclient-basic
-brew install instantclient-sqlplus
-```
-
-#### Connect
-
-```bash
-sqlplus ${DBUSER}/${DBUSERPASSWORD}@//${HOST}:${PORT}/${SERVICE_NAME}
-```
-
-where `SERVICE_NAME` is the same thing as "database name" as in MySQL terminology
-
 ### Shell Commands
 
 #### Display UTF8

diff --git a/docs/docs/configuration.mdx b/docs/docs/configuration.mdx
@@ -6,6 +6,9 @@ title: Configuration
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+JAX-RS Jersey doesn't specify how application configurations are to be loaded. jersey-webservice-template, however,
+utilizes a library called [owner](https://owner.qubitpi.org/). 
+
 The configurations in this page can be set from several sources in the following order:
 
 1. the [operating system's environment variables]; for instance, an environment variable can be set with
@@ -18,6 +21,8 @@ The configurations in this page can be set from several sources in the following
 Note that environment config has higher priority than Java system properties. Java system properties have higher
 priority than file based configuration.
 
+[owner]: https://owner.qubitpi.org/
+
 CI/CD
 -----
 

diff --git a/docs/docs/crud/elide/data-model.md b/docs/docs/crud/elide/data-model.md
@@ -24,20 +24,14 @@ between two models, to denote which field is the identifier field, and to [secur
 Annotations
 -----------
 
-Elide has first class support for
-[JPA (Java Persistence API)](http://www.oracle.com/technetwork/java/javaee/tech/persistence-jsp-140049.html)
-annotations. These annotations serve double duty by both:
+Elide has first class support for JPA (Java Persistence API) annotations. These annotations serve double duty by both:
 
 - describing the attributes, relationships, and id field of a model.
 - provide an object relational mapping that can be used by an Elide data store to persist the model.
 
 Elide makes use of the following JPA annotations: `@OneToOne`, `@OneToMany`, `@ManyToOne`, `@ManyToMany`, `@Id`,
 `@EmbeddedId`, and `@GeneratedValue`.
 
-If more information about JPA is need, please
-[review their documentation](http://www.oracle.com/technetwork/java/javaee/tech/persistence-jsp-140049.html) or see
-our examples below.
-
 However, JPA is not required and Elide supports its own set of annotations for describing models:
 
 | Annotation Purpose       | JPA                         | Non-JPA           |

diff --git a/docs/docs/crud/index.mdx b/docs/docs/crud/index.mdx
@@ -56,7 +56,7 @@ view of our data that we wish to expose. In this example we will be modeling a _
 high-level familiarity with books in life. Our _Book_ model has been packaged as a **JAR** file in a
 [separate Maven project](https://github.com/QubitPi/jersey-webservice-template-jpa-data-models). It has already been
 published to Maven Central and will be installed in this tutorial by default so that user don't need to do anything
-to set up the data model at this moment <img width="70px" src="https://github.com/QubitPi/QubitPi/blob/master/img/可莉-21.png?raw=true" />
+to set up the data model at this moment
 
 Running
 -------