Skip to content

Commit

Permalink
PR to get dev back in line with main (#111)
Browse files Browse the repository at this point in the history
* Update dev-build.yml

include patch-styling-code branch in dev action

* Update build-adocs.yml

* Update dev-build.yml

To include dev-agi branch as push trigger

* Massive PR to get main updated with changes to dev branch (#105)

* Update build-adocs.yml

testing adding a personal deploy key (JO_PAT)

* Update build-adocs.yml

Reverting previous change

* WIP: creating dev deployment workflow

* WIP deploy to dev repository

* Update README.md

A test commit to the dev branch

* Update dev-build.yml

WIP- changing to new deploy key for dev

* Update README.md

Force a change to dev branch

* Update dev-build.yml

switch to PAT

* Update datasets.adoc

Forcing a change to datasets.adoc to test dev workflow

* Clearly state "DEV BRANCH" in Readme

* Try floating the menu

To bring the content nearer the top

* Update README.md

Remove the misleading stuff

* Update README.md

Use relative links so that they go to files in the same repository

* Link to the GitPages

Allows developer to see what they have achieved!

* Update abstract.asciidoc

https://docs.asciidoctor.org/asciidoc/latest/blocks/collapsible/ suggests that we can provide our own 'clickable text' instead of the default "Details". I have only done that to this element as an experiment to check it works.

* Update README.md

Link to where you should see the output of changes

* Reducing size of Index table

Remove "float" trial; make as two cells, like in the current GEMINI

* Update README.md

Changed title to say this is the dev branch, while working through step by step guide to editing in place

* Update README.md

* Update README.md

Changed the two absolute URLs to the correct domain

* Update dev-build.yml

* Changed gemini css to handle asciidoc collapsible blocks more like links, and changed the metadatadate partial to show how it works

* Update 1055-uk-gemini-major-changes-since-1-0.asciidoc

Added a colon to make the list styling more consistent throughout

* Updated static URLs in docs readme

* Updated all the partials asciidoc files with the new style for the collapsible elements

* Update README.md

Made a minor change to the readme to check that the updated personal access token works correctly

* Update 1048-uk-gemini-encoding-guidance.asciidoc

Some minor corrections:
section numbering leads to duplication of table of contents; I removed the "manual" one - on preview, this loses both, so I'll have to wait to see what happens on publication (to dev)

According to #2, the sample links should already have been to GitHub, although as of 2023-03-08, that is only true of one of each link on the live site. To save migrating the invalid XML samples from the live site (!), I've changed the second of each pair of links to point to GitHub (and removed the 'series' example link).

Need to migrate 1046-xml-order, or remove a lot of links to it (as it is no longer possible to automatically generate it as we could with the old "massive XML -> HTML" process.)

Fixed "end note" links to go directly to the relevant page (i.e. not [4] -> page 1047 "bibliography" under a different name -> an old edition of GEMINI!) - in fact, I removed that link as basically circular!

The source (live) page included a duplicate of "Figure 2" and the following explanatory paragraph; the duplicate figure had been migrated (but not the following paragraph). I've removed it. Similarly for the explanation of Figure 22a. Corrected 2.4.2 reference to "Figure 23" to the correct Figure 25.

How  to avoid URI namespace identifiers being converted to links in ASCII Doc? Fortunately, some of them have landing pages...

Manually numbered the "figures". They (the code fragments) look good in preview, less good in HTML)

* internal links should be to .html, not .htm!

* Update 1049-metadata-guidelines-for-geospatial-data-resources-part-2.asciidoc

Fix links mainly (including bizarre one which has for a long time pointed out to a quite different page on AGI's site & one which was pointing to 1244 but should have been to 1051!)
Also fixed headings and removed quite a few instances of {nbsp}

* Check & update 1051

Fixed links e.g. to be relative, to avoid going via the 'bibliography'
Removed link to 1040 (see #64 (comment))
Fix the two links which said they were to 1250-summary-table but weren't (even in the live page!)
Removed {nbsp}s, some of which were preventing ASCIIdoc "constrained bold" formatting

See #96 - there's some duplication between this page & 1051.

* Update 1051-uk-gemini-v2-2-specification-for-discovery-metadata-for-geospatial-resources.asciidoc

Remove odd link that claimed to be to some summary of INSPIRE IRs, but never has been.
And one formatting issue.
I don't know why the "sectnums" bit doesn't work; it looks the same pas page 1049, where it does!

* tidying

* Update 1052-metadata-guidelines-for-geospatial-data-resources-part-1.asciidoc

Change internal links to link:, and manually full-URL index to sectnums
Fix data.gov.uk CSW link - now at ckan.publishing.service.gov.uk
Tidy heading styles
Remove mention of bibliography on the assumption we won't migrate it (see #64 (comment))
Fix link to "Part 3", which had gone to the bibliography - even in the live pages!

* Update 1052 - fixed one heading w/ migrated format

* WIP PR to address discussion issue #91 (comment) around how to better style code fragments. This branch uses pygments for code highlighting, with some styling overrides in assets/gemini.css. It's not perfect but at least demonstrates how to get the styling to work. So far, abstract, additionalinformation, boundingbox, characterencoding and metadatadate have been done

* added pygments-default.css to the WIP patch-styling-branch

* added highlighttest to see if pygments is actually working in the github version of asciidoctor

* Update dev-build.yml

* Update dev-build.yml

* WIP test relative URLs in readme page

* WIP- made changes to encoding guidelines for conformity, coupledresource, dataformat, dataquality, datasetlanguage, equivalentscale and extent

* 1056 Glossary Page checked- plus tweak to stylesheet to add some padding to the left and right of the content and header divs

* finished the encoding changes for the remaining partials. Renamed datasets and services to the correct name. Added ulist.html.slim to improve line-spacing for ordered lists. Edited gemini.css to change list-style inside disclosure blocks to remove linebreak between number and list item

* corrected urls in readme and added additional parameters for using slim template in command examples

* Update dev-build.yml

* Update dev-build.yml

* Update dev-build.yml

* corrected URL for datasets page

* Update dev-build.yml

* Made some corrections to services doc and partials

* Checked and tweaked 1037

* added a page for 1046-xml-element-order, made a few editorial changes to make it look neater

* added 1250-element-summary

* added 1053 common metadata errors

* added first pass at 1054 operational guide

* added additional pages to README

* created a separate branch to hold version of docs that have agi URLs rather than archaeogeek

* added corrected dev-build.yml

* Added pages that were previously missing

* Finished formatting guidelines part 3 and corrected typo in conformity

---------

Co-authored-by: Peter Parslow <[email protected]>

* Fixed readme and workflow actions for main branch

* Fixed title of datasets and series page

* Fixed title of docs readme page

* Fixed links in docs readme

* fixed workflow action in main branch

* Styling fixes for 1051 page

* Styling fixes for 1051 page

* Fixes to references in 1054

* additional fonts needed (#108)

* Css changes for additional fonts (#109)

* additional fonts needed

* additional fonts needed

* Css changes (#110)

* additional fonts needed

* additional fonts needed

* additional fonts needed

---------

Co-authored-by: Peter Parslow <[email protected]>
  • Loading branch information
archaeogeek and PeterParslow authored Sep 13, 2023
1 parent fca6e04 commit f46754b
Show file tree
Hide file tree
Showing 21 changed files with 150 additions and 67 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build-adocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ jobs:
id: adocbuild-datasets
uses: avattathil/asciidoctor-action@master
with:
program: "asciidoctor -a variant-dataset -a stylesheet=assets/gemini.css -a docinfo1 'docs/*.asciidoc' 'docs/*.adoc'"
program: "asciidoctor -a variant-dataset -a docinfo1 -T templates -E slim 'docs/*.asciidoc' 'docs/*.adoc'"
- name: Build services variant
id: adocbuild-services
uses: avattathil/asciidoctor-action@master
with:
program: "asciidoctor -a variant-service -a stylesheet=assets/gemini.css -a docinfo1 'docs/*.asciidoc' 'docs/*.adoc'"
program: "asciidoctor -a variant-service -a docinfo1 -T templates -E slim 'docs/*.asciidoc' 'docs/*.adoc'"
- name: Deploy docs to ghpages
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/dev-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- dev
- dev-agi
workflow_dispatch:

jobs:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
== UK GEMINI v2-2 Specification for Discovery Metadata for Geospatial Resources
= UK GEMINI v2-2 Specification for Discovery Metadata for Geospatial Resources
include::./includes/attributes.asciidoc[]

Return to https://www.agi.org.uk/gemini/40-gemini/1037-uk-gemini-standard-and-inspire-implementing-rules[GEMINI
2.3 home page]

:sectnums:
:sectnumlevels: 3
Return to link:1037-uk-gemini-standard-and-inspire-implementing-rules[GEMINI 2.3 home page]

== Foreword

Expand Down Expand Up @@ -230,9 +226,10 @@ the link:1250-element-summary[summary table].

Details of the metadata elements are given in :

link:datasets.html[GEMINI - Datasets and dataset series]
link:1062-gemini-datasets-and-data-series.html[GEMINI - Datasets and dataset series]

link:1063-gemini-services.html[GEMINI - Services]

link:services.html[GEMINI - Services]

Each element listed separately, with the following information:

Expand Down
101 changes: 52 additions & 49 deletions docs/1054-operational-guide.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,59 +10,60 @@ Contents

link:1054-operational-guide.html#Intro[1.Introduction]

link:1054-operational-guide.html#1.1[1.1 Target audience]
link:1054-operational-guide.html#Target[1.1 Target audience]

link:1054-operational-guide.html#1.2[1.2 Assumed knowledge]
link:1054-operational-guide.html#Assumed[1.2 Assumed knowledge]

link:1054-operational-guide.html#1.3[1.3 DMS resources]
link:1054-operational-guide.html#DMS[1.3 DMS resources]

link:1054-operational-guide.html#1.4[1.4 Where to obtain more information]
link:1054-operational-guide.html#Info[1.4 Where to obtain more information]

link:1054-operational-guide.html#Pub_Dis_Met[2. Publishing Discovery Metadata]

link:1054-operational-guide.html#2.1[2.1 Requirements on data providers and publishers]
link:1054-operational-guide.html#Req[2.1 Requirements on data providers and publishers]

link:1054-operational-guide.html#2.2[2.2 Accountability]
link:1054-operational-guide.html#Account[2.2 Accountability]

link:1054-operational-guide.html#2.3[2.3 Publishing discovery metadata for data]
link:1054-operational-guide.html#PubDisMet_Data[2.3 Publishing discovery metadata for data]

link:1054-operational-guide.html#2.4[2.4 Publishing discovery metadata for on-line services]
link:1054-operational-guide.html#PubDisMet_Services[2.4 Publishing discovery metadata for on-line services]

link:1054-operational-guide.html#2.5[2.5 Maintaining discovery metadata]
link:1054-operational-guide.html#Maintenance[2.5 Maintaining discovery metadata]

link:1054-operational-guide.html#2.6[2.6 Data sharing and charging and licensing]
link:1054-operational-guide.html#Sharing[2.6 Data sharing and charging and licensing]

link:1054-operational-guide.html#Dis_Met_Req[3. Discovery Metadata Requirements]

link:1054-operational-guide.html#3.1[3.1 Elements of importance to the DMS]
link:1054-operational-guide.html#Important_elements[3.1 Elements of importance to the DMS]

link:1054-operational-guide.html#3.2[3.2 Data provider licence information]
link:1054-operational-guide.html#DataProvider_Licence[3.2 Data provider licence information]

link:1054-operational-guide.html#3.3[3.3 Metadata encoding]
link:1054-operational-guide.html#Encoding[3.3 Metadata encoding]

link:1054-operational-guide.html#3.4[3.4 Metadata validation]
link:1054-operational-guide.html#Validation[3.4 Metadata validation]

link:1054-operational-guide.html#3.5[3.5 Community extensions to UK GEMINI2]
link:1054-operational-guide.html#Community_Extensions[3.5 Community extensions to UK GEMINI2]

link:1054-operational-guide.html#3.6[3.6 Extensions to code lists]
link:1054-operational-guide.html#CodeList_Extensions[3.6 Extensions to code lists]

link:1054-operational-guide.html#3.7[3.7 Local guidance]
link:1054-operational-guide.html#Guidance[3.7 Local guidance]

link:1054-operational-guide.html#Pub_Dis_Met_rec[4. Publishing Discovery Metadata records]

link:1054-operational-guide.html#4.1[4.1 Publishing discovery metadata records]
link:1054-operational-guide.html#Pub_Dis_Met_rec_1[4.1 Publishing discovery metadata records]

link:1054-operational-guide.html#4.2[4.2 Registering the harvest location]
link:1054-operational-guide.html#Register_Harvest[4.2 Registering the harvest location]

link:1054-operational-guide.html#4.3[4.3 Collection]
link:1054-operational-guide.html#Collection[4.3 Collection]

link:1054-operational-guide.html#Met_Pub_Tec[5. Metadata Publishing and Technology Choices]

link:1054-operational-guide.html#5.1[5.1 UK Location metadata editor]
link:1054-operational-guide.html#UKLME[5.1 UK Location metadata editor]

link:1054-operational-guide.html#5.2[5.2 Geonetwork publishing solution]
link:1054-operational-guide.html#Geonetwork[5.2 Geonetwork publishing solution]

link:1054-operational-guide.html#Third_Party[5.3 Third party solutions]

link:1054-operational-guide.html#5.3[5.3 Third party solutions]

== 1. Introduction
[#Intro]
Expand Down Expand Up @@ -96,7 +97,8 @@ instance, please use the appropriate contact information listed under
“Where to obtain more information” below.

=== 1.1 Target Audience
[#1.1]

[#Target]

The primary audience for the Guide are business managers and information
officers, located within data provider organisations, and their
Expand All @@ -111,7 +113,8 @@ understanding of the UK Location Discovery Metadata Service and how it
is intended to operate.

=== 1.2 Assumed Knowledge
[#1.2]
[#Assumed]


This guide assumes that the reader is familiar with the creation and
management of metadata and has read the UK Location “Getting Started'
Expand Down Expand Up @@ -146,15 +149,15 @@ If you as a Data Provider publish directly, then you will perform both
the roles of Data Provider and Data Publisher.

=== 1.3 DMS Resources
[#1.3]
[#DMS]

The latest versions of all the UK Location resources referred to in this
guide can be found via the UK Location Resource Centre:

https://data.gov.uk/[http://data.gov.uk/location]

=== 1.4 Where to Obtain More Information
[#1.4]
[#Info]

The latest information, and additional resources, can be obtained by
visiting the{nbsp}UK Location{nbsp}web site.
Expand All @@ -169,17 +172,17 @@ Wales or Northern Ireland, please contact:

Alex Ramage, Spatial Information Policy, Scottish Government

Email:{nbsp}[#cloak0b5016abbce4537d6078242300c59c9c]#[email protected]#
Email:{nbsp}[email protected]

*Wales*

Geography & Technology, Welsh Assembly Government

E-mail:{nbsp}[#cloak0de48b02b62ff6b0733df4ab33e5b829]#mailto:[email protected][[email protected]]#
E-mail:{nbsp}[email protected]

*Northern Ireland*

Email:{nbsp}[#cloak4e2ac9d8ddb12cb122f38a77142a18f4]#[email protected]#{nbsp}or
Email:{nbsp}[email protected]{nbsp}or
visit the{nbsp}Spatial NI{nbsp}website at{nbsp}https://www.spatialni.gov.uk/

== 2. Publishing Discovery Metadata
Expand All @@ -192,7 +195,7 @@ metadata catalogue, which forms part of the public data access portal,
data.gov.uk.

=== 2.1 Requirements on Data Providers and Publishers
[#2.1]
[#Req]

Deciding to publish data into UK Location is a major commitment. INSPIRE
and UK Location is not a simple cataloguing service of what data exists
Expand Down Expand Up @@ -248,7 +251,7 @@ listed in the INSPIRE Data Specifications:
[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[8]]

=== 2.2 Accountability
[#2.2]
[#Account]

Accountability for publishing data and associated resources rests with
you the Data Provider. If you are a Data Provider and are publishing
Expand All @@ -259,7 +262,7 @@ Data Provider, e.g. in relation to INSPIRE compliance and conformance to
INSPIRE and UK Location technical guidance.

=== 2.3 Publishing Discovery Metadata for Data
[#2.3]
[#PubDisMet_Data]

The process for publishing metadata records for data is shown as a
process model below.
Expand Down Expand Up @@ -310,7 +313,7 @@ errors are found, then the Data Publisher will need to correct these and
re-submit the resource.

=== 2.4 Publishing Discovery Metadata for On-line Services
[#2.4]
[#PubDisMet_Services]

The process for publishing metadata records for on-line services is
shown as a process model below.
Expand Down Expand Up @@ -338,7 +341,7 @@ an existing service, in which case it will be an update of the existing
registration.

==== 2.5 Maintaining Discovery Metadata
[#2.5]
[#Maintenance]

UK Location requires that Data Providers and their Data Publishers
maintain their published metadata records in line with the INSPIRE
Expand All @@ -349,7 +352,7 @@ view service, then you are responsible for ensuring that these changes
are updated in your metadata.

==== 2.6 Data Sharing and Charging and Licensing
[#2.6]
[#Sharing]

Data sharing, including charging and licensing, 3rd party intellectual
property, and e-commerce issues are covered under separate UK Location
Expand Down Expand Up @@ -394,7 +397,7 @@ For metadata describing services,
click{nbsp}link:1063-gemini-services[here].

=== 3.1 Elements of importance to the DMS
[#3.1]
[#Important_elements]

Some metadata elements are particularly important to the operation of
the DMS, rather than to the users of the DMS.
Expand Down Expand Up @@ -447,7 +450,7 @@ further information about a service.
|===

=== 3.2 Data Provider Licence information
[#3.2]
[#DataProvider_Licence]

The following Data Provider licensing information must be provided:

Expand All @@ -467,7 +470,7 @@ the Use Constraints text field exactly as quoted here, for example “Open
Government Licence”.

=== 3.3 Metadata Encoding
[#3.3]
[#Encoding]

UK Location discovery metadata records must be published as an
Extensible Markup Language (XML) document. This must follow
Expand All @@ -476,7 +479,7 @@ Location UK GEMINI Encoding
Guidance]{nbsp}[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3.html[28]].

=== 3.4 Metadata Validation
[#3.4]
[#Validation]

Published discovery metadata XML document resources will be validated in
a three stage process, using:
Expand All @@ -492,7 +495,7 @@ on using its Schematron rules
[link:1047-metadata-guidelines-for-geospatial-data-resources-part-3[29]].

=== 3.5 Community Extensions to UK GEMINI2
[#3.5]
[#Community_Extensions]

Within a given organisation or thematic community, there may be the need
to record additional items of metadata to meet local requirements.
Expand All @@ -505,7 +508,7 @@ record XML document. These elements must be taken from ISO 19115 and be
encoded in conformance with ISO 19139.

=== 3.6 Extension to Code Lists
[#3.7]
[#CodeList_Extensions]

UK GEMINI2 includes a number of code lists taken from ISO 19115. Within
a given organisation or thematic community, you may wish to extend these
Expand All @@ -515,7 +518,7 @@ wish to extend a code list for an INSPIRE metadata element, please
contact the UK Location Coordination Unit.

=== 3.7 Local Guidance
[#3.7]
[#Guidance]

The type of data being published will have a strong bearing on the
content of the metadata created. It is strongly recommended that data
Expand All @@ -537,7 +540,7 @@ makes them available within data.gov.uk, and for further collection on
to Europe.

=== 4.1 Publishing Discovery Metadata records
[#4.1]
[#Pub_Dis_Met_rec_1]

This involves transferring your completed discovery metadata records to
an on-line location, which can be machine accessed through the Internet.
Expand Down Expand Up @@ -600,7 +603,7 @@ Filtering, by category or element, please contact the UK Location
Coordination Unit, using the contact form at:{nbsp}https://defra.gov.uk/.

=== 4.2 Registering the harvest location
[#4.2]
[#Register_Harvest]

UK Location discovery metadata records are registered using the UK
Government data publishing and discovery
Expand Down Expand Up @@ -735,7 +738,7 @@ at an interval specified by the Data Publisher
address specified by the Data Publisher, e.g. to a central error log

=== 4.3 Collection
[#4.3]
[#Collection]

The collection task created as described above is only run when
requested, that is, when you click the ‘Refresh’ button for that harvest
Expand Down Expand Up @@ -867,7 +870,7 @@ it is recommended that you then discuss your specific requirements with
your IT department and/or system supplier.

=== 5.1 UK Location Metadata Editor
[#5.1]
[#UKLME]

UK Location includes its own Metadata Editor that can be used by Data
Providers and Publishers to create compliant discovery metadata records.
Expand All @@ -881,7 +884,7 @@ For more information, to register for the on-line service or to download
the configuration package, please visit the UK Location Resource Centre.

=== 5.2 GeoNetwork Publishing Solution
[#5.2]
[#Geonetwork

The use of GeoNetwork as the basis for the UK Location Metadata Editor
provides the option for Data Providers and Publishers to extend a local
Expand All @@ -898,7 +901,7 @@ products, please
visit:{nbsp}http://geonetwork-opensource.org/[http://geonetwork-opensource.org]

=== 5.3 Third Party Solutions
[#5.3]
[#Third_Party]

Most of the providers of Geospatial Information Systems provide metadata
creation and publishing tools as part of their solution packages.
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ Where content differs between datasets and services, an [asciidoctor conditional
To generate using the asciidoctor docker container, use the `-a` parameter, from the docs folder:

```
docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -a stylesheet=./assets/gemini.css -T templates -E slim -a variant-dataset *.adoc *.asciidoc
docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -T templates -E slim -a variant-dataset *.adoc *.asciidoc
```

Then repeat for services:

```
docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -a stylesheet=./assets/gemini.css -T templates -E slim -a variant-service *.adoc *.asciidoc
docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor -a docinfo1 -T templates -E slim -a variant-service *.adoc *.asciidoc
```

## Styling
Expand Down
31 changes: 31 additions & 0 deletions docs/assets/agi.css

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions docs/assets/autoptimize.css

Large diffs are not rendered by default.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
18 changes: 18 additions & 0 deletions docs/assets/omgf/omgf-stylesheet-104/omgf-stylesheet-104.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/**
* Auto Generated by OMGF
* @author: Daan van den Bergh
* @url: https://daan.dev
*/

@font-face {
font-family: 'Source Sans Pro';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url('./assets/omgf/omgf-stylesheet-104/source-sans-pro-normal-400.eot');
src:
url('./assets/omgf/omgf-stylesheet-104/source-sans-pro-normal-400.woff2') format('woff2'),
url('./assets/omgf/omgf-stylesheet-104/source-sans-pro-normal-400.woff') format('woff'),
url('./assets/omgf/omgf-stylesheet-104/source-sans-pro-normal-400.ttf') format('ttf'),
url('./assets/omgf/omgf-stylesheet-104/source-sans-pro-normal-400.svg') format('svg');
}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit f46754b

Please sign in to comment.