Skip to content

Commit

Permalink
#2104: Adjust Enceladus 3 documentation
Browse files Browse the repository at this point in the history
* Some initial fixes
  • Loading branch information
benedeki committed Aug 6, 2022
1 parent 781deb0 commit 09d06f1
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
22 changes: 15 additions & 7 deletions _docs/3.0.0/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<tomcat IP>/menas-VERSION` path on your local server.

## Spark Jobs

### Prerequisites

### Deploying

1 change: 0 additions & 1 deletion _docs/3.0.0/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion _docs/3.0.0/usage/data-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion _docs/3.0.0/usage/spark-jobs-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ spark-jobs_<build_version>.jar \
--row-tag <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

Expand Down
5 changes: 0 additions & 5 deletions _docs/usage/menas-api.md

This file was deleted.

0 comments on commit 09d06f1

Please sign in to comment.