geonetwork / doc Goto Github PK

@pvgenuchten and my self were discussing the possibility to provide to the users a working template that, when validated, has all green lights.

The required fields will have generic content such as "put here the name of your organization" but we should warn the users that even if the validation is ok it could be a false positive.

As a consequence, users should be sure to insert his/her own right information.

https://gitter.im/pvgenuchten

I recently removed the _build folder as the results had not been updated for some years.

It turns out this folder is used externally by transifex:

Autoupdate has stopped for a resource Autoupdate for the file annexes--index was paused after several failed attempts to access the file. The error message from the server was:

404 Client Error: Not Found for url: https://raw.githubusercontent.com/geonetwork/doc/develop/_build/locale/annexes/index.pot

You can resume auto update by updating the link to the file.If you plan to stop auto-update for this file, please disregard this message.

It appears that this is controlled by a .tx/config file in our repository, which documents pot files being published in _build/locale.

The link at the top right of https://geonetwork-opensource.org/manuals/3.4.x/en/index.html goes to https://github.com/geosource-catalogue/doc/blob/develop/en/index.rst, whereas I think it should go here: https://github.com/geonetwork/doc/blob/develop/source/index.rst. I assume this is a setting that needs to be changed rather than a typo!

Under "New Features" you've linked to localhost when you're trying to redirect to the new Rest API documentation:

http://www.geonetwork-opensource.org/manuals/trunk/eng/users/overview/change-log/version-3.2.0.html

https://geonetwork-opensource.org/manuals/trunk/en/user-guide/associating-resources/index.html needs a new screenshot as per geonetwork/core-geonetwork#3804 and also information from geonetwork/core-geonetwork#3817

the section should also be described from a user perspective

https://geonetwork-opensource.org/manuals/trunk/en/user-guide/workflow/suggestion.html

I was reminded of this section of the docs by a recent article with ZFS changing to the use of "dependents".

A conversation last year with @juanluisrp suggested the term "master" / "minion" which believe works (and a suggests a working together). There are some established guidelines here that may be considered for context.

https://geonetwork-opensource.org/manuals/trunk/en/customizing-application/creating-custom-view.html needs new screenshots and additional documentation relating to geonetwork/core-geonetwork#3191

• We have pot files in github, is this necessary?
  https://github.com/geonetwork/doc/tree/develop/_build/locale

• What files transifex is using? Looks to be pot, right?

Transifex is using pot files. See https://github.com/geonetwork/doc/blob/develop/Makefile#L68

• How do we synch transifex with github?

Use

make update_translations

• Is it automatic?

• When we change a letter in a rst file in English, what happens on transifex ? I'm afraid we will lose the translations as the msgid is the english phrase ?

msgid "This section gives some guidelines to write consistent documentation for |project_name|."
msgstr ""

• Is there a way to build rst files in a language from pot?

@Delawen maybe you've some answers ? thanks.

https://geonetwork-opensource.org/manuals/3.8.x/en/api/csw.html

Checklist to collect many small fixes.

Installing the application:

• Installing from the installer is empty!
• Installing form WAR file is actually about Tomcat, and does not provide configuration direction
• Installing from source code - Move content to GitHub repo README.md and link to it
• Installing remote index - can we just say Elastic Search
• Configuring the database - does this database have a name? Can we have headings for H2 and PostgreSQL
• data directory, should this be before installing?
• loading templates and sample data <-- is this a dup with quickstart?

Recommendation:

• Maintenance Guide can discuss trade offs during installation, quickstart should not
• Adopt a numbered step approach or template (especially for installation)

See:

• GeoNetwork Orientation which has point form notes of all the different installation options

To ensure the documentation is consistent, we need a style guide. For example, how do we refer to the Catalog(ue)? Is it a catalog(ue) or a portal? What spelling do we use for the english version? I will start one in the wiki.

the section how to interact with the map viewer is quite minimal. I suggest to add a separate page to explain map interactions. The page would list:

• navigation tools
• search by location
• Add layers, TOC
• Store, share and open maps
• WPS
• Data filter
• 3D
• Projection switcher
• Feature info
• Print
• Measure
• Annotations

ref: https://geonetwork-opensource.org/manuals/3.6.x/en/api/rdf-dcat.html

Is there an end point?

I know you can get RDF DCAT from a path like:

{your service}/srv/eng/rdf.metadata.get?uuid={some_uuid}

or

{your service}/srv/eng/rdf.metadata.get?id={some_id}

but I can't find an end point

The documentation suggests that there should be an example of a listener that prints a string every time a metadata gets removed, however the example seems to be missing:

https://github.com/geonetwork/doc/blob/develop/source/tutorials/hookcustomizations/events/index.rst#simple-example

This page is blank: https://geonetwork-opensource.org/manuals/trunk/en/user-guide/workflow/versioning.html but the whole Workflow section at https://geonetwork-opensource.org/manuals/trunk/en/user-guide/workflow/index.html probably needs updating

https://geonetwork-opensource.org/manuals/3.6.x/en/user-guide/workflow/suggestion.html#metadata-suggestion

We are currently trying to update from GNOS 3.6 to 3.8. Unfortunately the DB then "disappears", i.e. data do not show up in 3.8.

Looking at the documentation:

"Updating the application"

• https://geonetwork-opensource.org/manuals/trunk/en/maintainer-guide/updating/index.html
• https://github.com/geonetwork/doc/blob/develop/source/maintainer-guide/updating/index.rst

... does not have any content.

Please document how to do upgrading (or add pointers to existing documentation elsewhere). Thanks!

https://geonetwork-opensource.org/manuals/3.4.x/en/api/z39-50.html

https://geonetwork-opensource.org/manuals/4.0.x/en/maintainer-guide/installing/installing-index.html#installing-index talks about a folder /es/config, however a deployed war does not have a folder /es, are these files anywhere available in the war, or only in the sources? in that case, better to reference the files on a public location (github?)

Projection switcher changes need adding to https://geonetwork-opensource.org/manuals/trunk/en/administrator-guide/configuring-the-catalog/system-configuration.html. Is there even a section in the help guide for the map?

https://geonetwork-opensource.org/manuals/trunk/en/user-guide/harvesting/harvesting-csw.html needs a refresh and also to include information from geonetwork/core-geonetwork#4076 and geonetwork/core-geonetwork#4066

Although the q search is apparently still using the old api and doesn't appear in the swagger documentation, it is very useful and it would be helpful if it was documented.

Note this is in progress, based on the information supplied by @josegar74 in this thread on the user mailing list: https://sourceforge.net/p/geonetwork/mailman/message/36627750/

I propose to include it in the api section of the website as an option in this page: https://geonetwork-opensource.org/manuals/trunk/en/api/index.html

https://geonetwork-opensource.org/manuals/trunk/en/user-guide/harvesting/harvesting-thredds.html needs to include information from geonetwork/core-geonetwork#3936

This seem related to the transifex translations, doing a mvn clean install takes more than 5 minutes.

This is really slow, but maybe should be done in other way? If the build process is still valid, this should be improved I think.

I'm doing a change in 3.4.x and seem used the english rst files, not very clear if should be changed that files or in transifex.

There should be a section in https://geonetwork-opensource.org/manuals/3.8.x/en/customizing-application/editor-ui/creating-custom-editor.html on using inflate-metadata.xsl to automatically add elements to a metadata record if they are not present.

• https://geonetwork-opensource.org/manuals/trunk/en/administrator-guide/index.html

• https://geonetwork-opensource.org/manuals/trunk/en/user-guide/quick-start/index.html#starting-the-catalog

Probably more

https://geonetwork-opensource.org/manuals/3.4.x/en/api/oai-pmh.html

Codelists.xml is mentioned as part of https://geonetwork-opensource.org/manuals/3.8.x/en/customizing-application/implementing-a-schema-plugin.html?highlight=codelists%20xml but it should be expanded to include more information, such as using "displayif" to use a different codelist depending on the context

Hi Everyone im traing to deploy the project using Jboss but i get this error, someone please could help me? Thanks a lot

{"WFLYCTL0080: Servicios fallidos" => {"jboss.persistenceunit."geonetwork.war#default"" => "javax.persistence.PersistenceException: [PersistenceUnit: default] Unable to build Hibernate SessionFactory
Caused by: javax.persistence.PersistenceException: [PersistenceUnit: default] Unable to build Hibernate SessionFactory
Caused by: org.hibernate.MappingException: Could not get constructor for org.hibernate.persister.collection.OneToManyPersister
Caused by: org.hibernate.HibernateException: Unable to parse order-by fragment
Caused by: java.lang.ClassCastException: class antlr.CommonToken cannot be cast to class antlr.Token (antlr.CommonToken is in unnamed module of loader 'deployment.geonetwork.war' @1ba96c42; antlr.Token is in unnamed module of loader '[email protected]' @3ea4211e)"}}

https://geonetwork-opensource.org/manuals/3.4.x/en/api/rdf-dcat.html

The documentation on the versioning is empty.

https://github.com/geonetwork/doc/blob/develop/source/user-guide/workflow/versioning.rst

Based on the older 2.10.x, there was some versioning documentation in the past.

https://github.com/geonetwork/core-geonetwork/blob/2.10.x/docs/eng/users/source/managing_metadata/versioning/index.rst

Is versioning still supported? If so - does anyone know why that the versioning documentation was not migrated from 2.10.x to 3.x? It seems like it would be better to have some versioning documentaiton (even if it may be a little outdated) vs having an empty page.

Thank you

Hi, this more a question than issue so apologies.

Is http://www.geonetwork-opensource.org/manuals/trunk/eng/users/administrator-guide/managing-metadata-standards/index.html#adding-a-schema

still currently the preferred way of adding a schema?

I see the UI has a "Add or Update a standard" input and I'm wondering if that is the same functionality?

I'd like to add https://marinemetadata.org/references/marineprofile19115 to the latest geonetwork builds and try out the improved metadata editing and faceting UI for users contributing marine metadata.

Thanks!

The two images used in https://geonetwork-opensource.org/manuals/4.0.x/en/customizing-application/implementing-a-schema-plugin.html#editor-behaviour-adding-schema-suggestions-xml-and-schema-substitutes-xml are out of date and refer to GeoNetwork 2.x. They are:

• https://github.com/geonetwork/doc/blob/develop/source/customizing-application/img/Editor-Constraints-Choices-Modified.png
• https://github.com/geonetwork/doc/blob/develop/source/customizing-application/img/Editor-Constraints-Choices.png

since 3.8 ogc harvester has an undocumented feature which allows to synchronise against the external capabilities, while being able to improve the generated records from a previous harvester run

in order for browsers to know opensearch is available on a geonetwork instance, the browser checks the index page at root, in many cases geonetwork is installed in a subfolder and it depends how the routing from home to that subfolder is managed in order to have the browser pick up the opensearch. we need to document this aspect. So either install geonetwork at root, or create a proper forward from / -> /geonetwork

you can test opensearch on a deployed geonetwork in chrome by: enter the url in url-bar, type a space and notice a website prefix occuring (or not, if opensearch is not detected)

failing: vanilla.geocat.net

operational: nationaalgeoregister.nl

Configuration needs to go in here: https://geonetwork-opensource.org/manuals/trunk/en/administrator-guide/configuring-the-catalog/user-interface-configuration.html then we need to include geonetwork/core-geonetwork#3778

based on this blog

Best practices

• use https (risk of blocked mixed content)
• persistent uri's (no mention of geonetwork in url)
• register sitemap at search console
• place robots.txt at root of site, link to sitemap, hide pages in a non human friendly format
• favicon.ico at root of site
• monitor traffic (404, 500, 403)
• set up CORS properly (limit webproxy to allow access only to secure sources)

• parameters which are needed to keep the system running, even if the number of metadata grows quickly
• how to set up map printing
• how to set up and use wps process
• how to set up and use data filter
• configuration of the map viewer
• how can reviewer find records to review
• use of INSPIRE etf validator
• set up and use the workflow/draft
• set up and use directory (subtemplates)
• thesauri management
• create thumbnail for metadata

https://geonetwork-opensource.org/manuals/trunk/en/user-guide/harvesting/harvesting-ogcwxs.html needs updating to take into account geonetwork/core-geonetwork#3257 and also to include #74

Going to make a checklist so we can collect many small feedbacks :)

quickstart:

• assumes installation and/or docker available

  • "after going through installer steps" ... install instructions under "maintainer guide" is appropriate? No that page is empty...
  • "when you use docker" - but no docker instructions are anywhere to be found

  Indeed this quickstart page is the top pick when searching for docker instructions for geonetwork.

• Recommend: include install instructions here, no discussion of trade-offs like maintainer section, just step by step instructions installation

• installer quickstart page, step by step instructions from download to running start.bat

• tomcat quickstart page (replacing a war install instructions)

• docker quickstart page (recommend: Include docker instructions, or link to them)

Recommendation:

• Adopt a numbered step approach or template
• Break into individual pages?
• Adopt consistent RST syntax to avoid basic markup, and make use of directives (see Sphinx RST Style guide )

See:

• GeoNetwork Orientation which has point form notes of all the different installation options

We're moving the installation instructions from the Quick Start, which means that the installation section at https://geonetwork-opensource.org/manuals/trunk/en/maintainer-guide/installing/index.html needs to be reviewed, and in particular needs a section on docker

currently empty https://geonetwork-opensource.org/manuals/3.8.x/en/annexes/mef-format.html

https://geonetwork-opensource.org/manuals/3.4.x/en/api/opensearch.html

Hi !

I try to follow the "Create new formatter" tuto, but i need more details about the step 4 :

Add a custom less file in wro4j inspected folders and link it to your formatter

Where is this folder ?

Thanks.

https://geonetwork-opensource.org/manuals/trunk/en/administrator-guide/configuring-the-catalog/user-interface-configuration.html (plus updated screenshots required)

It is unclear which projection is required here: https://geonetwork-opensource.org/manuals/3.6.x/en/user-guide/harvesting/harvesting-ogcwxs.html

The WMS should support the WGS84 projection

Is that EPSG:4326 WGS84 lat/long or CRS:84 WGS84 long/lat or even EPSG:6326