Skip to content

Commit 228cac9

Browse files
tomkralidispvgenuchten
authored andcommitted
editorial updates
1 parent 03522a8 commit 228cac9

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

docs/1-metadata-at-the-source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ identification:
5151
If you are comfortable with Python, consider to try the following experiment.
5252

5353
:::{.callout-tip}
54-
Download a mcf sample [pygeometa repository](https://raw.githubusercontent.com/geopython/pygeometa/refs/heads/master/sample.yml). Then open a shell and set up a virtual Python (or COnda) environment, then:
54+
Download an MCF sample [pygeometa repository](https://raw.githubusercontent.com/geopython/pygeometa/refs/heads/master/sample.yml). Then open a shell and set up a virtual Python (or Conda) environment, then:
5555

5656
```bash
5757
pip3 install pygeometa
@@ -70,7 +70,7 @@ When tagging the dataset with keywords, preferably use keywords from controlled
7070

7171
MCF documents can be written in a text editor like [Visual Studio Code](https://code.visualstudio.com). Consider to install the [YAML plugin](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) for instant YAML validation.
7272

73-
Another option to create and update mcf files is via [MDME](https://github.com/osgeo/mdme). MDME is a web based software package providing a dynamic metadata edit form. An operational package is available at [osgeo.github.io](https://osgeo.github.io/mdme). Notice that if you install the package locally, you can customize the metadata model to your organizational needs.
73+
Another option to create and update MCF files is via [MDME](https://github.com/osgeo/mdme). MDME is a web based software package providing a dynamic metadata edit form. An operational package is available at [osgeo.github.io](https://osgeo.github.io/mdme). Notice that if you install the package locally, you can customize the metadata model to your organizational needs.
7474

7575
:::{.callout-tip}
7676
Imagine a dataset you have recently worked with. Then open [mdme](https://osgeo.github.io/mdme) and populate the form, describing that dataset. Now save the MCF file so we can later place it in a sample data repository.

docs/3-catalogue-publication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Return to the command line, press ctrl-C to stop the Docker container process.
4444

4545
[Compose](https://docs.docker.com/compose/) is a utility of docker, enabling setup of a set of containers using a composition script. A composition script can automate the manual startup operations of the previous paragraph. We've prepared a composition script for this workshop. The script includes, besides the pycsw container, other containers from next paragraphs.
4646

47-
Clone the workshop repository to a local folder (You don't have git installed? You can also download the repository as a [zip file](https://github.com/pvgenuchten/training-gitops-sdi/archive/refs/heads/main.zip)).
47+
Clone the workshop repository to a local folder (You don't have Git installed? You can also download the repository as a [zip file](https://github.com/pvgenuchten/training-gitops-sdi/archive/refs/heads/main.zip)).
4848

4949
```bash
5050
git clone https://github.com/pvgenuchten/training-gitops-sdi.git
@@ -100,7 +100,7 @@ docker exec -it pycsw bash -c "pycsw-admin.py delete-records -c /etc/pycsw/pycsw
100100

101101
Notice at <http://localhost:8000/collections/metadata:main/items> that all records are removed.
102102

103-
We exported mcf records as iso19139 in the [previous section](./2-interact-with-data-repositories.md).
103+
We exported MCF records as iso19139 in the [previous section](./2-interact-with-data-repositories.md).
104104
Copy the ISO XML documents to the `./docker/data/export` folder in the Docker project. This folder will be mounted into the container, so the records can be loaded into the pycsw database.
105105

106106
Use pycsw-admin.py to load the records into the catalogue database:

docs/5-git-cicd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Welcome to *my website*.
5656
We've selected an alternative to jekyll, called [quarto](https://quarto.org).
5757
In order to activate Quarto you need to set a number of items yourself.
5858

59-
- Create a file `_quarto.yml` into the new git repository, with this content:
59+
- Create a file `_quarto.yml` into the new Git repository, with this content:
6060

6161
```yaml
6262
project:
@@ -141,7 +141,7 @@ We will now publish our records from GitHub to our database.
141141
```bash
142142
git clone https://github.com/username/records-repo.git
143143
```
144-
- Copy the mcf files, which have been generated in [Catalogue publication](./3-catalogue-publication.md), to a `data` folder in the cloned docker repository.
144+
- Copy the MCF files, which have been generated in [Catalogue publication](./3-catalogue-publication.md), to a `data` folder in the cloned docker repository.
145145
- Commit & push the files
146146

147147
```bash
@@ -211,7 +211,7 @@ Normally, we would **not** add a connection string to a database in a config fil
211211

212212
## Cross linking catalogue and Git
213213

214-
While users are browsing the catalogue (or this page), they may find irregularities in the content. They can flag this as an issue in the relevant Git repository. A nice feature is to add a link in the catalogue page which brings them back to the relevant mcf in the git repository. With proper authorizations they can instantly improve the record, or suggest an improvement via an issue or [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
214+
While users are browsing the catalogue (or this page), they may find irregularities in the content. They can flag this as an issue in the relevant Git repository. A nice feature is to add a link in the catalogue page which brings them back to the relevant MCF in the Git repository. With proper authorizations they can instantly improve the record, or suggest an improvement via an issue or [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
215215

216216
---
217217

docs/7-providing-map-services.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ But also vice versa; from a mapping application, access the metadata describing
6565
## Mapfile creation exercise
6666

6767
- Navigate with shell to a folder with data files.
68-
- Verify if mcf's are available for the files, if not, create initial metadata with `crawl-metadata --mode=init --dir=.`
68+
- Verify if MCFs are available for the files, if not, create initial metadata with `crawl-metadata --mode=init --dir=.`
6969
- Add a index.yml file to the folder. This metadata is introduced in the mapfile to identify the service.
7070

7171
```yaml
@@ -163,7 +163,7 @@ Check http://localhost/ows/foss4g/ogcapi in your browser. If all has been set up
163163
164164
You can also try the url in QGIS. Add a WMS layer, of service http://localhost/ows/foss4g?request=GetCapabilities&service=WMS.
165165
166-
Notice that the mcf.yml files now include a link to the mapservice via which the datasets are shared. These links have been added by the crawl-maps method (and use the `pgdc_ms_url` environment variable). Publish the records to the catalogue again, so users will be able to find the service while browsing the catalogue.
166+
Notice that the MCF files now include a link to the mapservice via which the datasets are shared. These links have been added by the crawl-maps method (and use the `pgdc_ms_url` environment variable). Publish the records to the catalogue again, so users will be able to find the service while browsing the catalogue.
167167
168168
pyGeoDataCrawler uses default (gray) styling for vector and an average classification for grids. You can finetune the styling of layers through the [robot section in index.yml](https://github.com/pvgenuchten/pyGeoDataCrawler?tab=readme-ov-file#layer-styling) or by providing an [Styled Layer Descriptor](https://www.ogc.org/standards/sld/) (SLD) file for a layer, as `{name}.sld`. Sld files can be created using QGIS (export style as SLD).
169169

docs/slides/index.qmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ format:
1212
# Contents
1313

1414
- What is GitOps?
15-
- Why efforts in GitOps?
15+
- Why GitOps?
1616
- Metadata at the source
1717
- About the workshop
1818
- Technologies
@@ -33,7 +33,7 @@ format:
3333
- Reconcile the desired state
3434
- Visibility and control
3535

36-
## Why efforts in GitOps?
36+
## Why GitOps?
3737

3838
At ISRIC - World Soil Informtion
3939

@@ -44,15 +44,15 @@ At ISRIC - World Soil Informtion
4444
## Metadata at the source
4545

4646
- Researchers use many field and earth observation data to predict distribution of Soil properties
47-
- They use tools like Excel, R & Python, generally not aware of metadata standards
47+
- They use tools like Excel, R and Python, generally not aware of metadata standards
4848

49-
- Add a README.txt to describe the resources in a folder
49+
- Add a `README.txt` to describe the resources in a folder
5050
- Why not structure the content in the README, so also machines can read it?
5151

5252
## About the workshop
5353

5454
- A self guided tutorial at <https://pvgenuchten.github.io/training-gitops-sdi/>
55-
- Two moments to summarise
55+
- Two moments to summarize
5656
- Welcoming your feedback at <https://forms.gle/J59DjGbTBx1s1Tus7>
5757
- Ask questions via <https://github.com/pvgenuchten/training-gitops-sdi/discussions/5>
5858

@@ -79,7 +79,7 @@ At ISRIC - World Soil Informtion
7979
- exports MCF to various metadata models (iso, dcat, stac)
8080
- <https://github.com/geopython/pygeometa>
8181

82-
## [pyGeoDataCrawler](https://pypi.org/project/geodatacrawler/1.3.5/)
82+
## [pyGeoDataCrawler](https://pypi.org/project/geodatacrawler)
8383

8484
- Developed at ISRIC in the last year
8585
- On the shoulders of giants; GDAL, pygeometa, pandas
@@ -115,7 +115,7 @@ Related products; [GeoNode](https://geonode.org/), [GeoMoose](https://geomoose.o
115115

116116
## Quarto
117117

118-
- Static site generator from markdown
118+
- Static site generator from Markdown
119119
- Add diagrams or maps with Python and R scripting
120120
- Other interesting option is the [W3C MapML](https://www.npmjs.com/package/@maps4html/mapml)
121121

0 commit comments

Comments
 (0)