From 763bcc00839d97f74a2d61d3b95fdfa1c95a1d14 Mon Sep 17 00:00:00 2001 From: Paul van Genuchten Date: Tue, 14 Nov 2023 00:01:57 +0100 Subject: [PATCH] fix some typos, add link to foss4g2023 --- workshop/content/docs/introduction.md | 7 ++++--- workshop/content/docs/setup.md | 9 +++++---- workshop/content/docs/standards.md | 10 +++++----- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/workshop/content/docs/introduction.md b/workshop/content/docs/introduction.md index 2b8ff53d..65f63d4c 100644 --- a/workshop/content/docs/introduction.md +++ b/workshop/content/docs/introduction.md @@ -20,18 +20,19 @@ The pygeoapi [website](https://pygeoapi.io) is the main entrypoint for both end- where you can find: * [official documentation](https://docs.pygeoapi.io) -* the [default/latest presentation](https://pygeoapi.io/presentations/default) +* the [default](https://pygeoapi.io/presentations/default) and [latest](https://pygeoapi.io/presentations/foss4g2023) presentations * [documentation and presentations archive](https://pygeoapi.io/documentation) * code on [GitHub](https://github.com/geopython/pygeoapi) * Docker images [available on Docker Hub](https://hub.docker.com/r/geopython/pygeoapi) +* pygeoapi releases in the [python package index (pypi)](https://pypi.org/project/pygeoapi/) Given pygeoapi implements a number of OGC API standards, you may also want to read about these on [ogcapi.ogc.org](https://ogcapi.ogc.org). ## Existing Deployments -A number of organizations have deployed pygeoapi to their operatios. To get a feel of how pygeoapi -is used in practice, check our up to date [live deployments page](https://github.com/geopython/pygeoapi/wiki/LiveDeployments). By +A number of organizations have deployed pygeoapi to their operations. To get a feel of how pygeoapi +is used in practice, check out our up to date [live deployments page](https://github.com/geopython/pygeoapi/wiki/LiveDeployments). By default, the pygeoapi public demo at [demo.pygeoapi.io](https://demo.pygeoapi.io) is always maintained and made available by the development team. Check out the [main instance](https://demo.pygeoapi.io/master) which always runs the latest GitHub version. diff --git a/workshop/content/docs/setup.md b/workshop/content/docs/setup.md index 6a997a59..3078709e 100644 --- a/workshop/content/docs/setup.md +++ b/workshop/content/docs/setup.md @@ -214,7 +214,7 @@ In addition to adapting the configuration you will usually add your own data as remote data services like PostGIS or WFS. You can also mount a local directory such as `data/` to `/pygeoapi/mydata` within the Container. -Within the data directory you can store vector data, raster files or sets of image of vector tiles. +Within the data directory you can store vector data, raster files or sets of image or vector tiles. Below is an example where the configuration is explictly set to `pygeoapi-config.yml` via an environment variable (`-e`) and uses a Docker mount to mount the local `data` folder as `/pygeoapi/mydata`: @@ -272,9 +272,10 @@ root@docker-desktop:/# python3 >>> conformance = w.conformance() >>> conformance -etc - +>>> quit() ``` - + +Type `exit` to return to exit the owslib docker container. + We will refer to this installation in some of the Exercises where OWSLib is used. diff --git a/workshop/content/docs/standards.md b/workshop/content/docs/standards.md index 6c3b8955..42d31086 100644 --- a/workshop/content/docs/standards.md +++ b/workshop/content/docs/standards.md @@ -17,7 +17,7 @@ a number of open standards (both formal and defacto or community driven). pygeoapi implements the [OGC API](https://ogcapi.ogc.org) suite of standards from the [Open Geospatial Consortium](https://www.ogc.org/) (OGC). From the OGC API website: -!!! cite +!!! Citation The OGC API family of standards are being developed to make it easy for anyone to provide geospatial data to the web. These standards build upon the legacy of the OGC Web Service standards (WMS, WFS, WCS, WPS, etc.), but define resource-centric APIs that take advantage of modern web development practices. This web page provides information on these standards in a consolidated location. @@ -26,17 +26,17 @@ pygeoapi implements the [OGC API](https://ogcapi.ogc.org) suite of standards fro #### OGC API - Common [OGC API - Common](https://ogcapi.ogc.org/common/) is a common framework used in all OGC API's. -OGC API - Common Common provides the following functionality: +OGC API - Common provides the following functionality: - based on [OpenAPI 3.0](https://spec.openapis.org/oas/latest.html) - HTML and JSON as the dominant encodings, alternative encodings are possible -- common and shared endpoints such as: +- shared endpoints such as: - `/` (landing page) - `/conformance` - `/openapi` - `/collections` - `/collections/foo` -- common aspects such as pagination, links between resources, basic filtering, query parameters (`bbox`, `datetime`, etc.) +- aspects such as pagination, links between resources, basic filtering, query parameters (`bbox`, `datetime`, etc.) OGC API - Common allows for specification developers to focus on the key functionality of a given API (i.e. data access, etc.) while using common constructs. This harmonizes OGC API standards and enables deeper integration with less code. This also @@ -123,7 +123,7 @@ GeoJSON for OGC API - Features, GeoTIFF for OGC API - Coverages) depending on th # pygeoapi specific conventions pygeoapi provides some conventions that are not put forth by OGC API standards, however facilitate -some features and capabiliteis. +some features and capabilities. ## the `f` parameter