Skip to content

Commit

Permalink
Check http links in documentation (#7496)
Browse files Browse the repository at this point in the history
* Check http links and update to https and more recent documentation as appropriate

* Replace external links to user manual with relative links between pages

* api docs no longer available, providing a list of valid profiles
  • Loading branch information
jodygarnett authored Nov 20, 2023
1 parent 01e2467 commit 8452a24
Show file tree
Hide file tree
Showing 24 changed files with 63 additions and 58 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To configure the discovery service, a dedicated service metadata record MUST be

## Loading INSPIRE codelists

To describe INSPIRE datasets and series, it is recommended to load relevant codelists from the [INSPIRE Registry](http://inspire.ec.europa.eu/registry/), the following codelists are relevant in the scope of metadata guidelines v2.0:
To describe INSPIRE datasets and series, it is recommended to load relevant codelists from the [INSPIRE Registry](https://inspire.ec.europa.eu/registry/), the following codelists are relevant in the scope of metadata guidelines v2.0:

- [INSPIRE Theme](https://inspire.ec.europa.eu/theme)
- [Application schema](https://inspire.ec.europa.eu/applicationschema)
Expand Down Expand Up @@ -54,7 +54,7 @@ Via the schema plugin form configuration it is an option to configure a thesauru

## INSPIRE validation

INSPIRE validation of metadata records is available at [the INSPIRE Validator](https://inspire.ec.europa.eu/validator/about/). It is using [ETF which is an open source testing framework for spatial data and services](https://github.com/etf-validator/etf-webapp). GeoNetwork is able to `te` any record using a service provided by an instance of ETF. To configure remote validation, go to `Admin console` --> `Settings` and set the URL of the validator. The url of the main INSPIRE validator is `http://inspire.ec.europa.eu/validator/`.
INSPIRE validation of metadata records is available at [the INSPIRE Validator](https://inspire.ec.europa.eu/validator/about/). It is using [ETF which is an open source testing framework for spatial data and services](https://github.com/etf-validator/etf-webapp). GeoNetwork is able to `te` any record using a service provided by an instance of ETF. To configure remote validation, go to `Admin console` --> `Settings` and set the URL of the validator. The url of the main INSPIRE validator is `https://inspire.ec.europa.eu/validator/`.

![image](img/inspire-configuration.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

To publish information from the catalog as OGC services (WMS, WFS, WCS), catalog administrator need to register one or more map servers to publish on. Map servers MUST support the GeoServer REST API in order to work with the catalog. The 2 following implementations have been tested:

- [GeoServer](http://geoserver.org)
- [Mapserver](http://mapserver.org) and [Mapserver REST API](https://github.com/neogeo-technologies/mra)
- [GeoServer](https://geoserver.org)
- [Mapserver](https://mapserver.org) and [Mapserver REST API](https://github.com/neogeo-technologies/mra)

Setup you map server and then register it from the administration interface:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ See [Configuring for the INSPIRE Directive](inspire-configuration.md).

## INSPIRE Atom Feed

Allows to define the configuration of Atom Feeds referenced by the metadata to provide services related to the [INSPIRE technical guidance for download services](http://inspire.ec.europa.eu/documents/Network_Services/Technical_Guidance_Download_Services_3.0.pdf):
Allows to define the configuration of Atom Feeds referenced by the metadata to provide services related to the [INSPIRE technical guidance for download services](https://inspire.ec.europa.eu/documents/Network_Services/Technical_Guidance_Download_Services_3.0.pdf):

- Select the type of atom feed:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ To assign a category to a metadata document. Go to the metadata modification for

To modify the available categories in the catalog, from the admin page, open the "classification systems" and then the "category" tab.

Note: If you add or modify categories, they may not obtain an appropriate icon. These icon are managed in `/catalog/style/gn_icons.less`. In this file category-classes are mapped to font-awesome variables that map to a certain [font-awesome icon](http://fontawesome.io).
Note: If you add or modify categories, they may not obtain an appropriate icon. These icon are managed in `/catalog/style/gn_icons.less`. In this file category-classes are mapped to font-awesome variables that map to a certain [font-awesome icon](https://fontawesome.io).
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ In order to define which groups the user is member of and which profile is the u
``` text
ldapUserContextMapper.mapping[privilege]=groups,sample
# If not set, the default profile is RegisteredUser
# Valid profiles are http://geonetwork-opensource.org/manuals/trunk/eng/developer/apidocs/geonetwork/org/fao/geonet/constants/Geonet.Profile.html
# Valid profiles are ADMINISTRATOR, USER_ADMIN, REVIEWER, EDITOR, REGISTERED_USER, GUEST
ldapUserContextMapper.mapping[profile]=privileges,RegisteredUser
```

Expand Down
6 changes: 3 additions & 3 deletions docs/manual/docs/annexes/standards/iso19115-3.2018.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ This schema also includes:

More information:

- [Using the latest ISO Standard for Geographic Information (ISO19115-1) for an INSPIRE Discovery Service](http://cnig.gouv.fr/wp-content/uploads/2015/06/titellus_fx_prunayre_iso19115-3_inspire2015.pdf)
- [Using the latest ISO Standard for Geographic Information (ISO19115-1) for an INSPIRE Discovery Service](https://www.iso.org/standard/53798.html)

This standard is maintained on <https://github.com/metadata101/iso19115-3.2018> and is available by default in GeoNetwork 3.8+. The TC211 is maintaining the XSD for this standard on <https://github.com/ISO-TC211/XML>.
This standard is maintained on <https://github.com/geonetwork/core-geonetwork/tree/master/schemas/iso19115-3.2018> and is available by default in GeoNetwork. The TC211 is maintaining the XSD for this standard on <https://github.com/ISO-TC211/XML>.

Example of catalogues using this standard:

- [Metawal - Catalogue pour l'information géographique de Wallonie](http://metawal.wallonie.be/) is using ISO19115-3 as the default standard for all records. Main advantages are: categorizations of related documents (eg. online sources, DQ reports, GIS styles, Data models), better description of organization / parties and roles, remain compliant to the INSPIRE directive by converting to ISO19139 through CSW.
- [Metawal - Catalogue pour l'information géographique de Wallonie](https://metawal.wallonie.be/) is using ISO19115-3 as the default standard for all records. Main advantages are: categorizations of related documents (eg. online sources, DQ reports, GIS styles, Data models), better description of organization / parties and roles, remain compliant to the INSPIRE directive by converting to ISO19139 through CSW.

![](img/metawal-tramedesaxes.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/help/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ GeoNetwork is a catalog application to manage spatially referenced resources. It

[GeoNetwork Manual](https://docs.geonetwork-opensource.org/4.4)

[GeoNetwork opensource](http://geonetwork-opensource.org)
[GeoNetwork opensource](https://geonetwork-opensource.org)
2 changes: 1 addition & 1 deletion docs/manual/docs/install-guide/configuring-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ GeoNetwork uses a database to persist aspects such as metadata records, privileg

## H2 database

By default, a [H2](http://www.h2database.com/html/main.html) database is configured and created when the application first starts. The H2 database named `gn.h2.db` is created:
By default, a [H2](https://www.h2database.com/html/main.html) database is configured and created when the application first starts. The H2 database named `gn.h2.db` is created:

- In the **`jetty`** folder of the GeoNetwork application folder when using the [ZIP distribution](installing-from-zip.md).
- In the **`bin`** folder of Tomcat when deploying the [WAR](installing-from-war-file.md) on Tomcat (started using `startup.sh`).
Expand Down
18 changes: 11 additions & 7 deletions docs/manual/docs/install-guide/installing-from-source-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

### Java 11

GeoNetwork 4.4 is a Java 11 application that runs as a servlet, which means that a Java Development Kit (JDK) must be installed in order to build and run it. You can get a Java 11 JDK from your Linux distribution, [Oracle OpenJDK](http://openjdk.java.net/) or [AdoptOpenJDK](https://adoptopenjdk.net). Please note that the Java 11 [Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads) is currently only being distributed for testing purposes.
GeoNetwork 4.4 is a Java 11 application that runs as a servlet, which means that a Java Development Kit (JDK) must be installed in order to build and run it. You can get a Java 11 JDK from your Linux distribution, [OpenJDK](https://openjdk.java.net/) or [Adoptium Temurin JDK](https://adoptopenjdk.net).

Please note that the commercial distribution of [Oracle JDK](https://www.oracle.com/technetwork/java/javase/downloads) no longer provides Java 11 for testing purposes.

Because GeoNetwork is developed with Java 11 (LTS), it won't run at all with earlier releases.

Expand All @@ -16,13 +18,15 @@ Because GeoNetwork is developed with Java 11 (LTS), it won't run at all with ea

Next, you need a servlet container. GeoNetwork ships with an embedded container, [Eclipse Jetty](https://www.eclipse.org/jetty/), which is fast and well-suited for most applications.

If you need a more powerful container, we recommend [Apache Tomcat](http://tomcat.apache.org). Tomcat provides load balancing, fault tolerance and other production features. Apache Tomcat is widely used with many organizations standardizing on Tomcat for all their Java Web Applications.
We highly recommend [Apache Tomcat](https://tomcat.apache.org). Apache Tomcat provides load balancing, fault tolerance and other production features. Apache Tomcat is widely used with many organizations as a standardized environment for all their Java Web Applications.

We recommend the following stable releases of Tomcat:

- Apache Tomcat 9.0
- Apache Tomcat 8.5

GeoNetwork cannot use the newer versions of Apache Tomcat 10 which are based on the Jakarata Enterprise Edition web application standard.

### Database

Regarding storage, you need a Database Management System (DBMS) like Oracle, MySQL, Postgresql etc. GeoNetwork comes with an embedded DBMS (H2) which is used by default during installation. This DBMS can be used for small or desktop installations of no more than a few thousand metadata records with one or two users. If you have heavier demands then you should use a professional, stand alone DBMS.
Expand All @@ -45,10 +49,10 @@ The software runs in different ways depending on the servlet container you are u
The following tools are required to be installed to setup a development environment for GeoNetwork:

- **Java 11** - Developing with GeoNetwork requires Java Development Kit (JDK) 11.
- **Maven** 3.1.0+ - GeoNetwork uses [Maven](http://maven.apache.org/) to manage the build process and the dependencies. Once is installed, you should have the mvn command in your path (on Windows systems, you have to open a shell to check).
- **Git** - GeoNetwork source code is stored and versioned in [a Git repository on Github](https://github.com/geonetwork/core-geonetwork). Depending on your operating system a variety of Git clients are available. Please check the Git website for some [alternatives](http://git-scm.com/downloads/guis) and good [documentation](http://git-scm.com/documentation). More documentation can be found on the [Github website](https://help.github.com/).
- **Ant** - GeoNetwork uses [Ant](http://ant.apache.org/) to build the installer. Version 1.6.5 works but any other recent version should be OK. Once installed, you should have the Ant command in your path (on Windows systems, you have to open a shell to check).
- **Sphinx** - To build the GeoNetwork documentation in a nice format, [Sphinx](https://www.sphinx-doc.org/) is used. Please note that if you don't have a Python interpreter on your system, Sphinx will not work, so you need to install [Python](https://www.python.org/downloads/).
- **Maven** 3.1.0+ - GeoNetwork uses [Maven](https://maven.apache.org/) to manage the build process and the dependencies. Once is installed, you should have the mvn command in your path (on Windows systems, you have to open a shell to check).
- **Git** - GeoNetwork source code is stored and versioned in [a Git repository on Github](https://github.com/geonetwork/core-geonetwork). Depending on your operating system a variety of Git clients are available. Please check the Git website for some [alternatives](https://git-scm.com/downloads/guis) and good [documentation](https://git-scm.com/documentation). More documentation can be found on the [Github website](https://help.github.com/).
- **Ant** - GeoNetwork uses [Ant](https://ant.apache.org/) to build the installer. Version 1.6.5 works but any other recent version should be OK. Once installed, you should have the Ant command in your path (on Windows systems, you have to open a shell to check).
- **mkdocs** - To build the GeoNetwork documentation in a nice format, [mkdocs](https://www.mkdocs.org) is used. Please note that if you don't have a Python interpreter on your system, Sphinx will not work, so you need to install [Python](https://www.python.org/downloads/).

## Building & Running

Expand Down Expand Up @@ -155,7 +159,7 @@ $ mvn install -o
$ mvn install -o -DskipTests -T 2C
```

Please refer to the [Maven documentation](http://www.sonatype.com/books/mvnref-book/reference/public-book.html) for any other options.
Please refer to the [Maven documentation](https://www.sonatype.com/books/mvnref-book/reference/public-book.html) for any other options.

### Run embedded Jetty server

Expand Down
7 changes: 4 additions & 3 deletions docs/manual/docs/install-guide/installing-from-war-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ At the end of the installation process you will end up with the web applications

Host ports requirements:

- Java web server [Apache Tomcat](http://tomcat.apache.org/) or [Jetty](https://www.eclipse.org/jetty/): 8080
- Java web server [Apache Tomcat](https://tomcat.apache.org/) or [Jetty](https://www.eclipse.org/jetty/): 8080
- [Elasticsearch](https://www.elastic.co/elasticsearch/): 9200
- [Kibana](https://www.elastic.co/kibana/): 5601
- Database eg. 5432 for a default [PostgreSQL](https://www.postgresql.org/) installation


For [Apache Tomcat](http://tomcat.apache.org/) we recommend the following versions: 8.5.x and 9.0.x.
For [Jetty](https://www.eclipse.org/jetty/) we the following versions: 9.4.x.
For [Apache Tomcat](https://tomcat.apache.org/) we recommend the following versions: 8.5.x and 9.0.x. The latest Apache Tomcat 10.x cannot be used at this time.

For [Jetty](https://www.eclipse.org/jetty/) we the following versions: 9.4.x. Newer versions to Jetty cannot be used at this time.

1. Download the WAR file

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/overview/change-log/version-3.0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## New features

- [Map viewer provides now 3D mode](https://github.com/geonetwork/core-geonetwork/pull/1012) using [Cesiumjs](http://cesiumjs.org/)
- [Map viewer provides now 3D mode](https://github.com/geonetwork/core-geonetwork/pull/1012) using [Cesiumjs](https://cesiumjs.org/)
- Make your map in the visualization tools and [save your maps in the catalog](https://github.com/geonetwork/core-geonetwork/issues/1036)
- [Spatial filter is now available on the minimap](https://github.com/geonetwork/core-geonetwork/issues/1051)
- [Browse catalog by INSPIRE themes](https://github.com/geonetwork/core-geonetwork/issues/1054) and use the new [INSPIRE icon set](https://github.com/titellus/INSPIRE-themes-icons)
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/overview/change-log/version-3.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- Editor / XML view provides code editing with syntax highlighting and more, \...
- Directories can be populated from catalog content
- Metadata import improved (import by URL, import multiple files at once, better error reports)
- GeoServer updated to [version 2.9.0](http://geoserver.org/)
- GeoServer updated to [version 2.9.0](https://geoserver.org/)
- Added schema.org tags for better indexing by search engine

## Removed features
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/overview/change-log/version-4.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Due to H2 database major update, when migrating from a previous version drop the
- JS/CSS cache database in \$DATA_DIR/wro4j-cache.mv.db
- Formatter cache database in \$DATA_DIR/data/resources/htmlcache/formatter-cache/info-store.mv.db

If using H2 as the main database consider migrating to an external database (see [Configuring the database](../../install-guide/configuring-database.md)) or read [H2 migration guide](http://www.h2database.com/html/migration-to-v2.html) and migrate the database to version 2 format.
If using H2 as the main database consider migrating to an external database (see [Configuring the database](../../install-guide/configuring-database.md)) or read [H2 migration guide](https://www.h2database.com/html/migration-to-v2.html) and migrate the database to version 2 format.

Then start the application.

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/overview/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

The GeoNetwork project started out in year 2001 as a Spatial Data Catalogue System for the Food and Agriculture organisation of the United Nations ([FAO](http://www.fao.org)), the United Nations World Food Programme ([WFP](http://www.wfp.org)) and the United Nations Environmental Programme ([UNEP](http://www.unep.org)).
The GeoNetwork project started out in year 2001 as a Spatial Data Catalogue System for the Food and Agriculture organisation of the United Nations ([FAO](https://www.fao.org)), the United Nations World Food Programme ([WFP](https://www.wfp.org)) and the United Nations Environmental Programme ([UNEP](https://www.unep.org)).

The project is widely used as the foundation of Spatial Data Infrastructures world wide (See [gallery](../annexes/gallery/index.md)).

Expand Down
Loading

0 comments on commit 8452a24

Please sign in to comment.