Skip to content

Commit

Permalink
Edited small typos and text. Some link fixes.
Browse files Browse the repository at this point in the history
Signed-off-by: ticheler <jeroen.ticheler@geocat.net>
  • Loading branch information
ticheler committed Dec 7, 2023
1 parent b76e777 commit 082ac03
Show file tree
Hide file tree
Showing 14 changed files with 357 additions and 39 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@

User documentation is managed in the [geonetwork/doc](https://github.com/geonetwork/doc) repository covering all releases of GeoNetwork.

The `docs` folder includes [geonetwork/doc](https://github.com/geonetwork/doc) as a git submodule. This documentation is compiled into html pages during a release for publishing on the [geonetwork-opensource.org](http://geonetwork-opensource.org) website.
The `docs` folder includes [geonetwork/doc](https://github.com/geonetwork/doc) as a git submodule. This documentation is compiled into html pages during a release for publishing on the [geonetwork-opensource.org](https://www.geonetwork-opensource.org) website.

Developer documentation located in README.md files in the code-base:

* General documentation for the project as a whole is in this README.md
* [Software Development Documentation](/software_development/) provides instructions for setting up a development environment, building Geonetwork, compiling user documentation, and making a releases
* [Software Development Documentation](/software_development/) provides instructions for setting up a development environment, building GeoNetwork, compiling user documentation, and making a releases
* Module specific documentation can be found in each module (assuming there is module specific documentation required)

6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

The GeoNetwork community takes the security of the software and all services based on the software product seriously. On this page you can find the versions for which the community provides security patches.

If you believe you have found a security vulnerability in the software or an implementation of the software, please report it to geonetwork@osgeo.org as described below. Do not publish the vulnerability in any public forums (such as twitter, email list or issue tracker).
If you believe you have found a security vulnerability in the software or an implementation of the software, please report it to geonetwork@osgeo.org as described below. Do not publish the vulnerability in any public forums (such as Twitter/X, email list or issue tracker).

## Supported Versions

Each GeoNetwork release is supported with bug fixes for a limited period, with patch releases made approximately every three to six months.

- We recommend to update to latest incremental release as soon as possible to address security vulnarabilities.
- We recommend to update to latest incremental release as soon as possible to address security vulnerabilities.
- Some overlap is provided when major versions are announced with both a current version and a maintenance version being made available to provide time for organizations to upgrade.

| Version | Supported | Comment |
| ----------- | ------------------ |------------------------ |
|-------------|--------------------|-------------------------|
| 4.2.x | :white_check_mark: | Current version |
| 4.0.x | :white_check_mark: | Maintenance version |
| 3.12.x | :white_check_mark: | Maintenance version |
Expand Down
7 changes: 3 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Documentation


This module contains:
* `manual` in Markdown format for mkdocs
* `manuals` in RST format for sphinx-build (vai https://github.com/geonetwork/doc)
* `manual` in Markdown format for MkDocs
* `manuals` in RST format for sphinx-build (via https://github.com/geonetwork/doc) - Legacy
* Change logs txt files
* [copyright.txt](copyright.txt) Copyright template
* `licenses` for library
* Utility folder with scripts to generate extra docs
* `translate` python module for help with sphinx-build to mkdocs
* `translate` python module for help with Sphinx-build migration to MkDocs
319 changes: 319 additions & 0 deletions docs/manual/LICENSE

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/manual/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Geonetwork Manual and Help
# GeoNetwork Manual and Help

Documentation for GeoNetwork opensource is available via https://geonetwork-opensource.org.
Documentation for GeoNetwork opensource is available via https://docs.geonetwork-opensource.org.

This documentation is written under the creative commons license [Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)](LICENSE.md).
This documentation is written under the Creative Commons license [Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)](LICENSE).

Reference:

* [Documentation Writing Guide](docs/devel/docs/docs.md)
* [Documentation Writing Guide](docs/devel/docs/index.md)

## Communication

The [project issue tracker](https://github.com/geonetwork/core-geonetwork/issues) is used for communication, with ongoing topics tagged [documentation](https://github.com/geonetwork/core-geonetwork/issues?q=is%3Aissue+label%3Adocumenation).

## Material for MkDocs

Documentation is [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) which is a Markdown documentation framework written on top of [MkDocs](https://www.mkdocs.org/).
Documentation is [MkDocs-material](https://squidfunk.github.io/mkdocs-material/) which is a Markdown documentation framework written on top of [MkDocs](https://www.mkdocs.org/).

If you are using python3:
If you are using Python3:

1. Install using ``pip3`` and build:

Expand Down Expand Up @@ -45,7 +45,7 @@ If you are using python3:

### VirtualEnv

If you use a python virtual environment:
If you use a Python virtual environment:

1. Activate virtual environment:

Expand All @@ -65,9 +65,9 @@ If you use a python virtual environment:

### Docker

If you are not familiar with python the mkdocs-material website has instructions for docker:
If you are not familiar with Python the MkDocs-material website has instructions for Docker:

1. Run mkdocs in Docker environment:
1. Run MkDocs in Docker environment:

```
docker pull squidfunk/mkdocs-material
Expand All @@ -90,7 +90,7 @@ If you are not familiar with python the mkdocs-material website has instructions

3. Both ``install`` and ``deploy`` are skipped (so ``mvn clean install`` is fine).

4. Use default profile to only build the default english docs:
4. Use default profile to only build the default English docs:

```
mvn install -Pdefault
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 @@ -6,7 +6,7 @@ This catalogue lists records of available datasets.

The catalogue uses ***GeoNetwork*** technology for listing, searching and reviewing records.

GeoNetwork is a catalog application to manage spatially referenced resources. It provides powerful metadata editing and search functions as well as an interactive web map viewer. GeoNetwork is widely used as the foundation of Spatial Data Infrastructures world wide.
GeoNetwork is a catalog application to manage spatially referenced resources. It provides powerful metadata editing and search functions as well as an interactive web map viewer. GeoNetwork is widely used as the foundation of Spatial Data Infrastructures worldwide.

!!! info "Reference"

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/help/map/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The map viewer has a number of features to explore the data:
* Location search including searching for your current position.

![Map viewer](img/map.png)
*Mapviewer*
*Map viewer*

## Add layers

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

GeoNetwork-opensource is a catalog allowing visitors to search and discover spatial information. Visitors are can the included map viewer to preview datasets interactively.
GeoNetwork opensource is a catalog allowing visitors to search and discover spatial information. Visitors are can the included map viewer to preview datasets interactively.

GeoNetwork provides the tools to managing spatially referenced resources including record editing.

Expand Down
4 changes: 2 additions & 2 deletions docs/manual/docs/overview/authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ In brief the committee votes on proposals on the geonetwork-dev mailinglist. Pro

### Members of the Project Steering Committee

- Emanuele Tajariol
- Florent Gravin
- Francois Prunayre
- Jeroen Ticheler - Chair
- Jo Cook
- Jose Garcia
- Paul van Genuchten
- Simon Pigot
- Jo Cook

### Former members of the PSC

- Andrea Carboni
- Archie Warnock
- Patrizia Monteduro
- Jesse Eichar
- Emanuele Tajariol

## Committers

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deleting a record

User must have editing privileges to be able to remove a record. This topic describes the various ways to delete a record.
The user must have editing privileges to be able to remove a record. This topic describes the various ways to delete a record.

There are different ways to remove a record:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@ This topic describes how to use the metadata editor.

## Using the editor toolbar

The top tool bar provides the main editor actions:
The top toolbar provides the most important functionality available to the editor:

![](img/editor-toolbar.png)

From left to right:

- Set metadata categories
- Set metadata group
- Advanced features (eg. versioning)
- Advanced features (e.g. versioning)
- `Validate` to run metadata validation
- `Cancel` to cancel all changes made since the beginning of the editing session
- `Save & Close` to save and close the editor
- `Save` to save the metadata or the template. The drowdown also allows to set if the edits are minor or not (ie. the change date of the metadata will not be updated if case of minor edits).
- `Save` to save the metadata or the template. The dropdown also allows to set if the edits are minor or not (i.e. the change date of the metadata will not be updated if case of minor edits).
- Change view mode for the editor form, enable tooltips or switch to advanced editor mode

## Navigating the form

To describe the resource, an editor can use the form, which provides different views. By default the editor provides:
To describe the resource, an editor can use the form, which provides different views. By default, the editor provides:

- a `simple view` displaying all fields from the metadata
- a `full view` based on the metadata standard and providing access to all descriptors from the standards
- an `XML view` displaying the record as an XML document
- a `Default` view displaying all fields from the metadata
- an `Advanced` view based on the metadata standard and providing access to all descriptors from the metadata standard in use
- an `XML` view displaying the record as an XML document

To switch from one view to another, use the following menu:

![](img/view-mode.png)

Once the view is selected, the editor can browse the list of fields to populate. He can also use the scroll-spy on the lower right corner to quickly access a section.
Once the view is selected, the editor can browse the list of fields to populate. He can also use the scroll-spy in the lower right corner to quickly access a section.

![](img/scoll-spy.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/manual/docs/user-guide/describing-information/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

This section describes how to catalog resources. First, user needs to choose a standard to use. In general, the following rules apply:

- [Dublin core](https://dublincore.org/) usually used for opendata portal, referencing publication, report, \...
- [Dublin core](https://dublincore.org/) usually used for open data portal, referencing publication, report, \...
- [ISO 19115/119/139](https://www.iso.org/iso/en/home/store/catalogue_tc/catalogue_detail.htm?csnumber=32557) used for spatial resources (eg. datasets, services, maps)
- [ISO 19110](https://www.iso.org/iso/en/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=39965) used for feature attribute table

The editor form provides uploading of data, graphics, documents, pdf files and any other content type. It supports among other:
The editor form provides uploading of data, graphics, documents, pdf files and any other content type. It supports among others:

- full standard support
- multilingual metadata editing,
Expand All @@ -27,4 +27,4 @@ The editor form provides uploading of data, graphics, documents, pdf files and a
- [Multilingual editing](multilingual-editing.md)
- [Describing resources for the INSPIRE directive](inspire-editing.md)

Based on user profiles (see [Creating user](../../administrator-guide/managing-users-and-groups/creating-user.md)), a dashboard provides easy access to their informations and tasks.
Based on user profiles (see [Creating user](../../administrator-guide/managing-users-and-groups/creating-user.md)), a dashboard provides easy access to their information and tasks.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Managing templates {#creating-templates}

Templates are metadata records that you can use for describing new resources. This topic describes how to load and manage templates.
Templates are metadata records that you can use as the starting point to describe new resources. This topic describes how to load and manage templates.

## Creating and managing templates

Expand Down
4 changes: 2 additions & 2 deletions docs/manual/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ plugins:
name: English
build: true
default: true
site_name: 'GeoNetwork Opensource (EN)'
site_name: 'GeoNetwork opensource (EN)'
- locale: fr
name: Français
build: !ENV [FRENCH,true]
site_name: 'GeoNetwork Opensource (FR)'
site_name: 'GeoNetwork opensource (FR)'
site_description: Catalogue GeoNetwork pour répertorier, rechercher et examiner les enregistrements.
nav_translations:
Home: Home
Expand Down

0 comments on commit 082ac03

Please sign in to comment.