From 66a8ca819192eed8754ce77697f8847e7a9d9d86 Mon Sep 17 00:00:00 2001 From: neo <48834031+SuperOctocat@users.noreply.github.com> Date: Thu, 9 Nov 2023 00:16:25 +1100 Subject: [PATCH] Fixed broken links and formatting in BUILDING.md (#7471) --- software_development/BUILDING.md | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/software_development/BUILDING.md b/software_development/BUILDING.md index 16fe522d14e..5abaf1db0cc 100644 --- a/software_development/BUILDING.md +++ b/software_development/BUILDING.md @@ -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] ------------------------------------------------------------------------ @@ -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 : @@ -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: @@ -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. @@ -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: @@ -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: @@ -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).