chore: tidy package readmes, replace Apollo Voyager with Voyager

aerogear · Jul 30, 2019 · 5bc8513 · 5bc8513
1 parent 84a3e02
commit 5bc8513
Show file tree

Hide file tree

Showing 19 changed files with 40 additions and 28 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -5,7 +5,7 @@ about: Create a report to help us improve
 ---
 
 <!--
-Thank you for reporting a possible bug in Apollo Voyager Server
+Thank you for reporting a possible bug in Voyager Server
 
 Please fill in as much of the template below as you can.
 

diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -5,7 +5,7 @@ about: Suggest an idea for this project
 ---
 
 <!--
-Thank you for suggesting an idea to make Apollo Voyager Server better.
+Thank you for suggesting an idea to make Voyager Server better.
 
 Please fill in as much of the template below as you're able.
 -->

diff --git a/.github/ISSUE_TEMPLATE/3-help.md b/.github/ISSUE_TEMPLATE/3-help.md
@@ -1,11 +1,11 @@
 ---
-name: "⁉️ Need help with Apollo Voyager Server?"
+name: "⁉️ Need help with Voyager Server?"
 about: Please file an issue in our repo.
 
 ---
 
 
-If you have a question about Apollo Voyager Server that is not a bug report or feature
+If you have a question about Voyager Server that is not a bug report or feature
 request, feel free to post it here.
 
 You can also reach the aerogear team at [#aerogear](ircs://chat.freenode.net:6697/aerogear) on [Freenode IRC](https://freenode.net/) or the 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to Apollo Voyager Server
+# Contributing to Voyager Server
 
 ## Issues
 
@@ -12,6 +12,6 @@
 
 ## Code of Conduct
 
-The Apollo Voyager Server project has a
+The Voyager Server project has a
 [Code of Conduct](./CODE_OF_CONDUCT.md)
 to which all contributors must adhere.
diff --git a/doc/api/api.md b/doc/api/api.md
@@ -1,6 +1,6 @@
-### Apollo Voyager Server API Documentation
+### Voyager Server API Documentation
 
-This API reference links to the individual API docs for each package in the Apollo Voyager Server Framework.
+This API reference links to the individual API docs for each package in the Voyager Server Framework.
 
 * [voyager-server]
 * voyager-audit

diff --git a/doc/guides/issues.md b/doc/guides/issues.md
@@ -6,11 +6,11 @@ The AeroGear team tracks issues for all of the AeroGear projects in the [AeroGea
 
 ## GitHub
 
-We understand that for some people, JIRA can be a barrier to entry for creating issues and contributing in general. The maintainers of the Apollo Voyager Server welcome issues created in GitHub. Feel free to [Create an Issue](https://github.com/aerogear/voyager-server/issues/new) and select from one of our issue templates. We will do our best to triage these issues in GitHub.
+We understand that for some people, JIRA can be a barrier to entry for creating issues and contributing in general. The maintainers of the Voyager Server welcome issues created in GitHub. Feel free to [Create an Issue](https://github.com/aerogear/voyager-server/issues/new) and select from one of our issue templates. We will do our best to triage these issues in GitHub.
 
 ## Asking for Help
 
-If you have a question about Apollo Voyager Server that is not a bug report or feature
+If you have a question about Voyager Server that is not a bug report or feature
 request, feel free to [create an issue using the help issue template](https://github.com/aerogear/voyager-server/issues/new?template=3-help.md).
 
 You can also reach the aerogear team at [#aerogear](ircs://chat.freenode.net:6697/aerogear) on [Freenode IRC](https://freenode.net/) or the 

diff --git a/examples/README.md b/examples/README.md
@@ -1,10 +1,10 @@
-# Apollo Voyager Server Examples
+# Voyager Server Examples
 
 Set of example applications that show how the AeroGear Voyager Server can be used.
 
 ## Examples
 
-* [Basic Example Application](./basic) - This typical hello world example shows how to set up Apollo Voyager Server.
+* [Basic Example Application](./basic) - This typical hello world example shows how to set up Voyager Server.
 * [Application with Authentication and Role Based Authorization](./keycloak) - This example shows how to add authentication and and role based access control to your application using [Keycloak](https://www.keycloak.org/)
 * [Conflict example](./conflicts) - Conflict handling example
 * [External REST API integration example](./restapi) - This example shows GraphQL integration with another API

diff --git a/packages/voyager-audit/README.md b/packages/voyager-audit/README.md
@@ -2,4 +2,6 @@
 
 [![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
 
-Apollo Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
+Adds Audit Logging functionality to Voyager Server. Audit logs can be consumed and visualised by the OpenShift EFK stack. (ElasticSearch + Fluentd + Kibana).
+
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-audit/package.json b/packages/voyager-audit/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aerogear/voyager-audit",
   "version": "0.7.0",
-  "description": "Adds audit logging capabilities to Apollo Voyager Server.",
+  "description": "Adds audit logging capabilities to Voyager Server.",
   "author": "AeroGear Team<aerogear@googlegroups.com>",
   "homepage": "http://aerogear.org",
   "license": "Apache-2.0",

diff --git a/packages/voyager-conflicts/README.md b/packages/voyager-conflicts/README.md
@@ -1,9 +1,7 @@
 # Apollo Voyager conflicts
 
+[![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
 
-## Usage
-
-```
-npm install @aerogear/voyager-conflicts
-```
+Provides server side conflict detection mechanisms for building offline enabled applications.
 
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-keycloak/README.md b/packages/voyager-keycloak/README.md
@@ -2,4 +2,6 @@
 
 [![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
 
-Apollo Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
+Adds Authentication and Authorization to Voyager Server using [keycloak](https://www.keycloak.org/index.html).
+
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-keycloak/package.json b/packages/voyager-keycloak/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aerogear/voyager-keycloak",
   "version": "0.7.0",
-  "description": "Adds Keycloak authentication and authorization to Apollo Voyager Server",
+  "description": "Adds Keycloak authentication and authorization to Voyager Server",
   "author": "AeroGear Team<aerogear@googlegroups.com>",
   "homepage": "http://aerogear.org",
   "license": "Apache-2.0",

diff --git a/packages/voyager-metrics/README.md b/packages/voyager-metrics/README.md
@@ -2,4 +2,6 @@
 
 [![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
 
-Apollo Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
+Adds Prometheus metrics to Voyager Server. Integrates with the AeroGear Mobile Metrics service.
+
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-metrics/package.json b/packages/voyager-metrics/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aerogear/voyager-metrics",
   "version": "0.7.0",
-  "description": "Adds Prometheus metrics to Apollo Voyager Server.",
+  "description": "Adds Prometheus metrics to Voyager Server.",
   "author": "AeroGear Team<aerogear@googlegroups.com>",
   "homepage": "http://aerogear.org",
   "repository": {

diff --git a/packages/voyager-server/README.md b/packages/voyager-server/README.md
@@ -1,3 +1,7 @@
 # voyager-server
 
-Apollo Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
+[![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
+
+The core Voyager Server module.
+
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-server/package.json b/packages/voyager-server/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aerogear/voyager-server",
   "version": "0.7.0",
-  "description": "The core Apollo Voyager Server library.",
+  "description": "The core Voyager Server library.",
   "author": "AeroGear Team<aerogear@googlegroups.com>",
   "homepage": "http://aerogear.org",
   "repository": {

diff --git a/packages/voyager-subscriptions/README.md b/packages/voyager-subscriptions/README.md
@@ -2,4 +2,6 @@
 
 [![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
 
-Apollo Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
+Simplifies the set up of GraphQL Subscriptions, used for real time updates.
+
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-tools/README.md b/packages/voyager-tools/README.md
@@ -2,4 +2,6 @@
 
 [![CircleCI](https://circleci.com/gh/aerogear/voyager-server.svg?style=svg)](https://circleci.com/gh/aerogear/voyager-server)
 
-Apollo Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
+Tooling library used across Voyager Server modules.
+
+Voyager Server makes it easier to build secure, production ready, realtime APIs with GraphQL. [Read the Docs Here](https://github.com/aerogear/voyager-server).
diff --git a/packages/voyager-tools/package.json b/packages/voyager-tools/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aerogear/voyager-tools",
   "version": "0.7.0",
-  "description": "Tooling library used across Apollo Voyager Server modules.",
+  "description": "Tooling library used across Voyager Server modules.",
   "author": "AeroGear Team<aerogear@googlegroups.com>",
   "homepage": "http://aerogear.org",
   "license": "Apache-2.0",