From 09d06f1e687690fabf3e373855de206121a02e75 Mon Sep 17 00:00:00 2001 From: David Benedeki Date: Sat, 6 Aug 2022 03:17:00 +0200 Subject: [PATCH] #2104: Adjust Enceladus 3 documentation * Some initial fixes --- _docs/3.0.0/deployment.md | 22 ++++++++++++++------- _docs/3.0.0/usage.md | 1 - _docs/3.0.0/usage/data-quick-start.md | 2 +- _docs/3.0.0/usage/spark-jobs-quick-start.md | 2 +- _docs/usage/menas-api.md | 5 ----- 5 files changed, 17 insertions(+), 15 deletions(-) delete mode 100644 _docs/usage/menas-api.md diff --git a/_docs/3.0.0/deployment.md b/_docs/3.0.0/deployment.md index 4454ce32c..aa9e15dc4 100644 --- a/_docs/3.0.0/deployment.md +++ b/_docs/3.0.0/deployment.md @@ -6,15 +6,23 @@ categories: - '3.0.0' --- -## Menas +## Rest Api + +### Prerequisites -### Prerequisits to deploying Menas are +### Deploying + +## Menas -- Tomcat 8.5+ to deploy the war to -- `HADOOP_CONF_DIR` environment variable. This variable should point to a folder containing Hadoop configuration files (`core-site.xml`, `hdfs-site.xml` and `yarn-site.xml`). These are used to query the HDFS for folder locations. -- MongoDB 4.0+ used as a storage -- _OPTIONAL_ [Spline 0.3.X](https://absaoss.github.io/spline/0.3.html) for viewing of the lineage from Menas. Even without Spline in Menas, Standardization and Conformance will log lineage to Mongo. +### Prerequisites -### Deploying Menas +### Deploying The easiest way to deploy Menas is to copy the `menas-VERSION.war` to `$TOMCAT_HOME/webapps`. This will create `/menas-VERSION` path on your local server. + +## Spark Jobs + +### Prerequisites + +### Deploying + diff --git a/_docs/3.0.0/usage.md b/_docs/3.0.0/usage.md index 79320bdc7..e4d79b927 100644 --- a/_docs/3.0.0/usage.md +++ b/_docs/3.0.0/usage.md @@ -38,7 +38,6 @@ This part of the documentations will show you how to use Enceladus, Menas as its - [Configuration]({{ docs_path }}/usage/menas-config) - [Conformance Rules]({{ docs_path }}/usage/menas-conformance-rules) -- [API]({{ docs_path }}/usage/menas-api) ## General diff --git a/_docs/3.0.0/usage/data-quick-start.md b/_docs/3.0.0/usage/data-quick-start.md index 695db4e54..28b9ab692 100644 --- a/_docs/3.0.0/usage/data-quick-start.md +++ b/_docs/3.0.0/usage/data-quick-start.md @@ -23,7 +23,7 @@ Data quality is all about 2 things: ## Spline -but as Spline is under heavy development, we will postpone extensive documentation about it. Enceladus currently runs with version 0.3.X and it works fine out of the box. Spline 0.3.X just needs to be deployed next to Menas. +As Spline is under heavy development, we will postpone extensive documentation about it. Enceladus currently runs with version 0.7.X and it works fine out of the box. Spline 0.7.X just needs to be deployed next to _Menas_/_Rest Api_. Data for Spline are recorded even if the Spline UI is not up and running. This means they can be viewed later without the need to care about it now. diff --git a/_docs/3.0.0/usage/spark-jobs-quick-start.md b/_docs/3.0.0/usage/spark-jobs-quick-start.md index fa1bbc506..ac60f8d35 100644 --- a/_docs/3.0.0/usage/spark-jobs-quick-start.md +++ b/_docs/3.0.0/usage/spark-jobs-quick-start.md @@ -88,7 +88,7 @@ spark-jobs_.jar \ --row-tag ``` -Here, nothing new is added for the quick run. Of course, there might be special options which are all documented in the [run documentation](https://absaoss.github.io/enceladus/docs/3.0.0/usage/run) +Here, nothing new is added for the quick run. Of course, there might be special options which are all documented in the [run documentation](run) ## Running with helper scripts diff --git a/_docs/usage/menas-api.md b/_docs/usage/menas-api.md deleted file mode 100644 index a5783c144..000000000 --- a/_docs/usage/menas-api.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: redirect -title: Usage - Menas API -permalink: /docs/usage/menas-api ----