Skip to content

Commit

Permalink
Fixed broken links and formatting in BUILDING.md (#7471)
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperOctocat authored Nov 8, 2023
1 parent 92295e5 commit 66a8ca8
Showing 1 changed file with 11 additions and 17 deletions.
28 changes: 11 additions & 17 deletions software_development/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

See [Installing from source code](https://docs.geonetwork-opensource.org/latest/install-guide/installing-from-source-code/) (Installation Guide)

Build GeoNetwork
----------------
## Build GeoNetwork

Once you checked out the code from Github repository, go inside the GeoNetwork’s root folder and execute the maven build command:
Once you checked out the code from GitHub repository, go inside the GeoNetwork’s root folder and execute the maven build command:

```
mvn clean install
```

If the build is successful you'll get an output like:
If the build is successful, you'll get an output like:
```
[INFO]
[INFO] ------------------------------------------------------------------------
Expand Down Expand Up @@ -41,8 +40,7 @@ If the build is successful you'll get an output like:

Your local maven repository now contain the GeoNetwork artifacts created (``$HOME/.m2/repository/org/geonetwork-opensource``).

Compilation options
-------------------
## Compilation options

Many Maven build options are available, for instance, you might like to use following options :

Expand All @@ -66,8 +64,7 @@ Many Maven build options are available, for instance, you might like to use foll

Please refer to the maven documentation for additional options, [Maven: The Complete Reference](https://books.sonatype.com/mvnref-book/pdf/mvnref-pdf.pdf)

Maven Profiles
--------------
## Maven Profiles

Maven profiles are used to enable additional build configuration or optional modules:

Expand All @@ -83,8 +80,7 @@ mvn install -Drelease

The `release` flag above asks `datastorage-s3`, `datastorage-jcloud`, `datastorage-cmis` and the `release` module to produce `zip` bundles for distribution.

Run Elasticsearch
-----------------
## Run Elasticsearch

GeoNetwork requires an Elasticsearch instance as an index.

Expand All @@ -102,8 +98,7 @@ GeoNetwork requires an Elasticsearch instance as an index.

3. For alternatives see [es/readme](../es/README.md).

Run Kibana
----------
## Run Kibana

1. To run, download using maven:

Expand All @@ -118,12 +113,11 @@ Run Kibana
mvn exec:exec -Dkb-start
```

3. For alternatives see [es/es-dashboard/readme](../es/es-dashboard/README.md).
3. For alternatives see [es/es-dashboards/readme](../es/es-dashboards/README.md).

Run embedded Jetty server
-------------------------
## Run embedded Jetty server

Maven comes with built-in support for Jetty via a [jetty-maven-plugin](https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html).
Maven comes with built-in support for Jetty via a [jetty-maven-plugin](https://eclipse.dev/jetty/documentation/jetty-12/programming-guide/index.html#jetty-maven-plugin).

To run GeoNetwork with the embedded Jetty server:

Expand Down Expand Up @@ -151,7 +145,7 @@ To run GeoNetwork with the embedded Jetty server:
mvn clean:clean@reset
```

5. For more information see [web/README.md](../web/README.md).
6. For more information see [web/README.md](../web/README.md).



Expand Down

0 comments on commit 66a8ca8

Please sign in to comment.