You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rya.apache.org by dl...@apache.org on 2020/12/16 16:55:38 UTC
[rya] 02/02: removed references to specific version of Rya in
rya.manual and replaced the specific version with just Closes
#321
This is an automated email from the ASF dual-hosted git repository.
dlotts pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rya.git
commit 447c1a4ae477f46675c4a60296db3f5eb2059b27
Author: adina <AD...@USNA.EDU>
AuthorDate: Mon Dec 14 18:06:23 2020 -0500
removed references to specific version of Rya in rya.manual and replaced the specific version with just <version> Closes #321
---
.../src/site/markdown/kafka-connect-integration.md | 18 +++++++++---------
extras/rya.manual/src/site/markdown/pcj-updater.md | 8 ++++----
extras/rya.manual/src/site/markdown/quickstart.md | 4 ++--
extras/rya.manual/src/site/markdown/rya-streams.md | 16 ++++++++--------
extras/rya.manual/src/site/markdown/shell.md | 16 ++++++++--------
5 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/extras/rya.manual/src/site/markdown/kafka-connect-integration.md b/extras/rya.manual/src/site/markdown/kafka-connect-integration.md
index ed31c33..a86ca3a 100644
--- a/extras/rya.manual/src/site/markdown/kafka-connect-integration.md
+++ b/extras/rya.manual/src/site/markdown/kafka-connect-integration.md
@@ -125,13 +125,13 @@ Name the file "quickstart-statements.nt" and use a text editor to write the foll
Use the ```rya.kafka.connect.client``` to write the file's contents to the topic we just made.
```
-java -jar rya.kafka.connect.client-4.0.0-incubating-shaded.jar write -f quickstart-statements.nt -t statements
+java -jar rya.kafka.connect.client-<version>-shaded.jar write -f quickstart-statements.nt -t statements
```
You may verify the statements were written by using the read command.
```
-java -jar rya.kafka.connect.client-4.0.0-incubating-shaded.jar read -t statements
+java -jar rya.kafka.connect.client-<version>-shaded.jar read -t statements
```
At this point you need to decide whether you are going to use an Accumulo or
MongoDB backed instance of Rya. The following steps are pretty much the same
@@ -148,7 +148,7 @@ cluster. To do this, you'll need to use the Rya Shell. Here's roughly what an
installation session should look like.
```
-java -jar rya.shell-4.0.0-incubating-shaded.jar
+java -jar rya.shell-<version>-shaded.jar
_____ _____ _ _ _
| __ \ / ____| | | | |
@@ -158,7 +158,7 @@ java -jar rya.shell-4.0.0-incubating-shaded.jar
|_| \_\__, |\__,_| |_____/|_| |_|\___|_|_|
__/ |
|___/
-4.0.0-incubating
+<version>
Welcome to the Rya Shell.
@@ -224,7 +224,7 @@ Install the shaded jar that contains the Accumulo Rya Sink connector.
```
mkdir confluent-4.1.0/share/java/kafka-connect-rya-accumulo
-cp rya.kafka.connect.accumulo-4.0.0-incubating-shaded.jar confluent-4.1.0/share/java/kafka-connect-rya-accumulo
+cp rya.kafka.connect.accumulo-<version>-shaded.jar confluent-4.1.0/share/java/kafka-connect-rya-accumulo
```
Then we need to configure the connector to read from the "statements" topic,
@@ -300,7 +300,7 @@ Mongo database. To do this, you'll need to use the Rya Shell. Here's roughly
what an installation session should look like.
```
-[root@localhost ~]# java -jar rya.shell-4.0.0-incubating-SNAPSHOT-shaded.jar
+[root@localhost ~]# java -jar rya.shell-<version>-shaded.jar
_____ _____ _ _ _
| __ \ / ____| | | | |
| |__) | _ __ _ | (___ | |__ ___| | |
@@ -309,7 +309,7 @@ what an installation session should look like.
|_| \_\__, |\__,_| |_____/|_| |_|\___|_|_|
__/ |
|___/
-4.0.0-incubating-SNAPSHOT
+<version>
Welcome to the Rya Shell.
@@ -371,7 +371,7 @@ Install the shaded jar that contains the Mongo Rya Sink connector.
```
mkdir confluent-4.1.0/share/java/kafka-connect-rya-mongo
-cp rya.kafka.connect.mongo-4.0.0-incubating-shaded.jar confluent-4.1.0/share/java/kafka-connect-rya-mongo
+cp rya.kafka.connect.mongo-<version>-shaded.jar confluent-4.1.0/share/java/kafka-connect-rya-mongo
```
Then we need to configure the connector to read from the "statements" topic,
@@ -490,4 +490,4 @@ It's difficult to get the Geo indexing into the Sail object that represents
Rya because the geo project is optional. While optional, we don't use dependency
injection to get the GeoRyaSailFactory into the application instead of the
normal Rya Sail Factory. An improvement to this project would be to resolve
-that problem so that it may do geo indexing while inserting statements.
\ No newline at end of file
+that problem so that it may do geo indexing while inserting statements.
diff --git a/extras/rya.manual/src/site/markdown/pcj-updater.md b/extras/rya.manual/src/site/markdown/pcj-updater.md
index 157bb13..4b4f267 100644
--- a/extras/rya.manual/src/site/markdown/pcj-updater.md
+++ b/extras/rya.manual/src/site/markdown/pcj-updater.md
@@ -257,12 +257,12 @@ fluo.yarn.worker.num.cores | Defines the number of CPUs that should be alloc
The RYA PCJ Updater Fluo App jar is in a special uber jar that contains a subset of dependencies.
This jar is represented by the maven coordinate
-`org.apache.rya:rya.pcj.fluo.app:3.2.11-incubating:fluo-app` and when Rya is
+`org.apache.rya:rya.pcj.fluo.app:<version>:fluo-app` and when Rya is
built from source, it can be found here:
-`rya/extras/rya.pcj.fluo/pcj.fluo.app/target/rya.pcj.fluo.app-3.2.11-incubating-fluo-app.jar`.
+`rya/extras/rya.pcj.fluo/pcj.fluo.app/target/rya.pcj.fluo.app-<version>-fluo-app.jar`.
The Rya fluo-app jar needs to be copied to Fluo here:
-`fluo-1.0.0-incubating/apps/rya_pcj_updater/lib/rya.pcj.fluo.app-3.2.11-incubating-fluo-app.jar`
+`fluo-1.0.0-incubating/apps/rya_pcj_updater/lib/rya.pcj.fluo.app-<version>-fluo-app.jar`
### 6. Initialize the Rya PCJ Updater Fluo App
@@ -297,7 +297,7 @@ $ rya
|_| \_\__, |\__,_| |_____/|_| |_|\___|_|_|
__/ |
|___/
-3.2.11-incubating
+<version>
Welcome to the Rya Shell.
diff --git a/extras/rya.manual/src/site/markdown/quickstart.md b/extras/rya.manual/src/site/markdown/quickstart.md
index 4483aa8..56dcbed 100644
--- a/extras/rya.manual/src/site/markdown/quickstart.md
+++ b/extras/rya.manual/src/site/markdown/quickstart.md
@@ -25,8 +25,8 @@ This tutorial will outline the steps needed to get quickly started with the Apac
## Prerequisites
-* Columnar Store (Accumulo)
-* Apache Rya code (Git: git://git.apache.org/incubator-rya.git)
+* Columnar Store (Accumulo or MongoDB) The tutorial will go forward using Accumulo
+* Apache Rya code (Git: https://gitbox.apache.org/repos/asf?p=rya.git or https://github.com/apache/rya.git)
* Maven 3.0 +
## Building from Source
diff --git a/extras/rya.manual/src/site/markdown/rya-streams.md b/extras/rya.manual/src/site/markdown/rya-streams.md
index bc2e57d..889ee38 100644
--- a/extras/rya.manual/src/site/markdown/rya-streams.md
+++ b/extras/rya.manual/src/site/markdown/rya-streams.md
@@ -118,10 +118,10 @@ Copy the RPM to the CentOS 7 machine the Query Manager will be installed on.
Install it using the following command:
```
-yum install -y rya.streams.query-manager-3.2.12-incubating.noarch.rpm
+yum install -y rya.streams.query-manager-<version>.noarch.rpm
```
-It will install the program to **/opt/rya-streams-query-manager-3.2.12**. Follow
+It will install the program to **/opt/rya-streams-query-manager-<version>**. Follow
the directions that are in the README.txt file within that directory to finish
configuration.
@@ -140,7 +140,7 @@ We assume Kafka is running on the local machine using the standard Kafka port
of 9092. Issue the following command:
```
-java -jar rya.streams.client-3.2.12-incubating-SNAPSHOT-shaded.jar add-query \
+java -jar rya.streams.client-<version>-shaded.jar add-query \
-i localhost -p 9092 -r rya-streams-quick-start -a true \
-q "SELECT * WHERE { ?person <urn:talksTo> ?employee .?employee <urn:worksAt> ?business }"
```
@@ -148,7 +148,7 @@ The Query Manager should eventually see that this query was registered and
start a Rya Streams job that will begin processing it using any Visibility
Statements that have been loaded into Rya Streams. If no results are observed
in step 6, then verify the Query Manager is working properly. Its logs can be
-found in **/opt/rya-streams-query-manager-3.2.12/logs**.
+found in **/opt/rya-streams-query-manager-<version>/logs**.
### Step 4: Start watching for results ###
@@ -156,7 +156,7 @@ We need to fetch the Query ID of the query we want to watch. This can be looked
up by issuing the following command:
```
-java -jar rya.streams.client-3.2.12-incubating-SNAPSHOT-shaded.jar list-queries \
+java -jar rya.streams.client-<version>-shaded.jar list-queries \
-i localhost -p 9092 -r rya-streams-quick-start"
```
@@ -173,7 +173,7 @@ need to use the Query ID **8dd689ee-9d16-4aa7-91c0-667cdb3ed81a**. Start
watching the Stream Query's output using the following command:
```
-java -jar rya.streams.client-3.2.12-incubating-SNAPSHOT-shaded.jar stream-results \
+java -jar rya.streams.client-<version>-shaded.jar stream-results \
-i localhost -p 9092 -r rya-streams-quick-start" -q 8dd689ee-9d16-4aa7-91c0-667cdb3ed81a
```
@@ -198,7 +198,7 @@ visibilities when we load the statements. Load the file using the following
command:
```
-java -jar rya.streams.client-3.2.12-incubating-SNAPSHOT-shaded.jar load-statements \
+java -jar rya.streams.client-<version>-shaded.jar load-statements \
-i localhost -p 9092 -r rya-streams-quick-start" -v "" -f ./quick-start-data.nt
```
@@ -383,4 +383,4 @@ we would need to break the queries into many Kafka Streams topologies. A single
Join node could be the entire topology where the input topic contains binding
sets that are emited from the left and right child. So long as which partition
the data is written to is based on a hash over the values of the join variables,
-then each worker will only receive data that is able to be joined.
\ No newline at end of file
+then each worker will only receive data that is able to be joined.
diff --git a/extras/rya.manual/src/site/markdown/shell.md b/extras/rya.manual/src/site/markdown/shell.md
index f641d13..b1821bc 100644
--- a/extras/rya.manual/src/site/markdown/shell.md
+++ b/extras/rya.manual/src/site/markdown/shell.md
@@ -31,21 +31,21 @@ in the artifact `rya.shell-<version>-bin.tar.gz`.
To install, simply extract the archive to the desired output directory
``` sh
-tar xzvf rya.shell-3.2.11-incubating-bin.tar.gz
+tar xzvf rya.shell-<version>-bin.tar.gz
```
You can optionally install the Rya Shell by adding its `bin` directory to your
shell's `PATH`.
``` sh
-$ echo "PATH=$PATH:path/to/rya.shell-3.2.11-incubating/bin" >> ~/.bash_profile
+$ echo "PATH=$PATH:path/to/rya.shell-<version>/bin" >> ~/.bash_profile
```
## Launching, Exiting and Help
```
# Launch the shell
-$ cd rya.shell-3.2.11-incubating-bin
+$ cd rya.shell-<version>-bin
$ bin/rya
# Or, if you added the rya shell to your path, you can just type:
@@ -59,7 +59,7 @@ $ rya
|_| \_\__, |\__,_| |_____/|_| |_|\___|_|_|
__/ |
|___/
-3.2.11-incubating
+<version>
Welcome to the Rya Shell.
@@ -162,14 +162,14 @@ It is possible to script the Rya Shell by writing multiple commands to a text
file and then load them into the shell with the `script` command:
```
-rya> script --file rya.shell-3.2.11-incubating/examples/example.script
+rya> script --file rya.shell-<version>/examples/example.script
```
## Logs
-Logging for the rya shell is written to the `rya.shell-3.2.11-incubating/logs`
+Logging for the rya shell is written to the `rya.shell-<version>/logs`
directory. Configuration of the logging is controlled by the
-`rya.shell-3.2.11-incubating/conf/log4j.properties` file.
+`rya.shell-<version>/conf/log4j.properties` file.
## Creating a Rya Instance
@@ -303,7 +303,7 @@ The `print-instance-details` command displays the configuration of the currently
rya/myAccumuloInstance:rya_> print-instance-details
General Metadata:
Instance Name: rya_
- RYA Version: 3.2.11-incubating
+ RYA Version: <version>
Users: myUserName
Secondary Indicies:
Entity Centric Index: