This document serves as a prerequisite knowledge checklist for Open Source contributors (Contributor(s)) to the Geoconnex system (System). The System is composed of multiple components which in turn leverage various Open Source software projects and their toolchains.
The system works as follows:
For specific contributor documentation on a particular software, follow the contributor specific documentation:
The Contributor should become proficient with the following programming languages, data models, file formats, toolchains, and the Geoconnex Components and related dependent services that comprise the System.
What the Yourls Action and Sitemap Generator for the Geoconnex Permanent Identifier (PID) Service are written in.
What the PID Service Geoconnex component is written in.
Used to create various scripts in the Geoconnex component toolchain.
File format used to create Sitemap Indexes and Sitemaps Files crawled by Google and Gleaner.
File format used to create mappings from Geoconnex IRIs to their corresponding location on the web.
File format used to structure and represent linked data, facilitating the expression of context and relationships within the data, commonly employed for enhanced data interoperability and semantics on the web.
File format used to build Docker images. Specifies how to package all Geoconnex components.
An xml document that contains URLs of a Publisher's http endpoints for which JSON-LD documents can be extracted and aggregated.
An xml document that contains URLs of Publisher specific sitemaps.
Geoconnex components are invariably deployed and orchestrated as Docker containers at runtime.
See Also Yaml,
Yourls is an open source URL shorter which the PID Server is built upon and deployed by Aggregators. The data pipeline created by the System which connects Publishers to Aggregators is performed here.
Pemanent Identifier Server is used to provide re-directs to Geoconnex webpages and provides a Sitemap Index of JSON-LD pages that Gleaner ingests to Geoconnex. It is implemented using cloud native services, leveraging GCP's Cloud Run and Cloud SQL.
See Also Reference Services
YOURLS on Cloud Run
Used by YOURLS to serve redirects to all Publishers. The current reference implementation used by pids.geoconnex.us is YOURLS on Cloud Run to scale the number of instances as requests are recieved from Users.
MySQL Database on Cloud SQL
Used by YOURLS to host all 1:1 and Regex URL mappings of webpages hosted by Publishers in Geoconnex. The structure of the tables is prescribed by YOURLS.