Skip to content

Commit 4f5e330

Browse files
authored
docs: update docs referencing jdk8 (#9807)
1 parent 71c966b commit 4f5e330

File tree

3 files changed

+22
-14
lines changed

3 files changed

+22
-14
lines changed

docs/developers.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ title: "Local Development"
1212
- [Docker Compose >=2.20](https://docs.docker.com/compose/)
1313
- Docker engine with at least 8GB of memory to run tests.
1414

15-
:::
16-
1715
On macOS, these can be installed using [Homebrew](https://brew.sh/).
1816

1917
```shell

metadata-jobs/mae-consumer-job/README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,43 @@ Today the job consumes from two important Kafka topics:
1717
> Where does the name **Metadata Audit Event** come from? Well, history. Previously, this job consumed
1818
> a single `MetadataAuditEvent` topic which has been deprecated and removed from the critical path. Hence, the name!
1919
20-
## Pre-requisites
21-
* You need to have [JDK8](https://www.oracle.com/java/technologies/jdk8-downloads.html)
22-
installed on your machine to be able to build `DataHub Metadata Service`.
20+
## Prerequisites
21+
22+
Follow the [main developer guide](../../docs/developers.md) to set up your development environment and install the required dependencies.
2323

2424
## Build
25+
2526
`Metadata Audit Event Consumer Job` is already built as part of top level build:
26-
```
27+
28+
```shell
2729
./gradlew build
2830
```
31+
2932
However, if you only want to build `MAE Consumer Job` specifically:
30-
```
33+
34+
```shell
3135
./gradlew :metadata-jobs:mae-consumer-job:build
3236
```
3337

3438
## Dependencies
35-
Before starting `Metadata Audit Event Consumer Job`, you need to make sure that [Kafka, Schema Registry & Zookeeper](../../docker/kafka-setup),
36-
[Elasticsearch](../../docker/elasticsearch), and [Neo4j](../../docker/neo4j) Docker containers are up and running.
39+
40+
Before starting `Metadata Audit Event Consumer Job`, you need to make sure that all backend services, including Kafka and ElasticSearch, are up and running. If GMS is healthy, then Kafka and ElasticSearch should be healthy as well.
3741

3842
## Start via Docker image
43+
3944
The quickest way to try out `Metadata Audit Event Consumer Job` is running the [Docker image](../../docker/datahub-mae-consumer).
4045

4146
## Start via command line
47+
4248
If you do modify things and want to try it out quickly without building the Docker image, you can also run
4349
the application directly from command line after a successful [build](#build):
44-
```
50+
51+
```shell
4552
MCL_CONSUMER_ENABLED=true ./gradlew :metadata-jobs:mae-consumer-job:bootRun
4653
```
4754

4855
## Endpoints
56+
4957
Spring boot actuator has been enabled for MAE Application.
5058
`healthcheck`, `metrics` and `info` web endpoints are enabled by default.
5159

metadata-service/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,18 @@ DataHub Metadata Service is a service written in Java consisting of multiple ser
99
2. A general-purpose Rest.li API for ingesting the underlying storage models composing the Metadata graph.
1010

1111
## Pre-requisites
12-
* You need to have [JDK8](https://www.oracle.com/java/technologies/jdk8-downloads.html)
13-
installed on your machine to be able to build `DataHub Metadata Service`.
12+
13+
Follow the [main developer guide](../docs/developers.md) to set up your development environment and install the required dependencies.
1414

1515
## Build
1616
`DataHub Metadata Service` is already built as part of top level build:
17-
```
17+
18+
```shell
1819
./gradlew build
1920
```
21+
2022
However, if you only want to build `DataHub Metadata Service` specifically:
21-
```
23+
```shell
2224
./gradlew :metadata-service:war:build
2325
```
2426

0 commit comments

Comments
 (0)