Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/guide-infcom.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: WIS2 Guide for INFCOM review

on:
push:
branches:
- INFCOM-4

env:
FILE_BASENAME: wis2-guide-DRAFT-INFCOM-4

jobs:
build-wis2-guide:
name: Generate documentation
runs-on: ubuntu-latest
steps:
- name: Install dependencies
run: |
sudo apt-get update -y \
&& sudo apt-get install -y pandoc \
&& sudo gem install asciidoctor asciidoctor-pdf
- name: checkout repository
uses: actions/checkout@master
- name: build documentation
run: |
mkdir -p /tmp/wis2-guide/guide/images \
&& cd guide \
&& asciidoctor --trace -o /tmp/wis2-guide/guide/${FILE_BASENAME}.html index.adoc \
&& asciidoctor --trace --backend docbook --out-file - index.adoc | pandoc --from docbook --to docx --output /tmp/wis2-guide/guide/${FILE_BASENAME}.docx \
&& asciidoctor --trace -r asciidoctor-pdf --trace -b pdf -o /tmp/wis2-guide/guide/${FILE_BASENAME}.pdf index.adoc \
&& cp images/*.png /tmp/wis2-guide/guide/images \
&& cd ..
- name: checkout gh-pages branch
uses: actions/checkout@master
with:
ref: gh-pages
- name: update gh-pages branch and publish
run: |
git checkout gh-pages
git config --global user.email "tomkralidis@gmail.com"
git config --global user.name "Tom Kralidis"
rm -rf guide/infcom
mkdir -p guide/infcom
mv -f /tmp/wis2-guide/* guide/infcom
git add .
git commit -am "update WIS2 Guide INFCOM build"
git push

4 changes: 2 additions & 2 deletions .github/workflows/guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
&& sudo apt-get install -y pandoc \
&& sudo gem install asciidoctor asciidoctor-pdf
- name: checkout repository
uses: actions/checkout@v3
uses: actions/checkout@master
- name: build documentation
run: |
mkdir -p /tmp/wis2-guide/guide/images \
Expand All @@ -30,7 +30,7 @@ jobs:
&& cp images/*.png /tmp/wis2-guide/guide/images \
&& cd ..
- name: checkout gh-pages branch
uses: actions/checkout@v3
uses: actions/checkout@master
with:
ref: gh-pages
- name: update gh-pages branch and publish
Expand Down
31 changes: 31 additions & 0 deletions .github/workflows/test-guide-infcom.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Test WIS2 Guide build for INFCOM review

on:
pull_request:
branches:
- INFCOM-4
paths:
- '**.adoc'

env:
FILE_BASENAME: wis2-guide-DRAFT-INFCOM-4

jobs:
build-wis2-guide:
name: Test documentation build
runs-on: ubuntu-latest
steps:
- name: Install dependencies
run: |
sudo apt-get update -y \
&& sudo apt-get install -y pandoc \
&& sudo gem install asciidoctor asciidoctor-pdf
- name: checkout repository
uses: actions/checkout@master
- name: build documentation
run: |
mkdir -p /tmp/wis2-guide/guide/images \
&& cd guide \
&& asciidoctor --trace -o /tmp/wis2-guide/guide/${FILE_BASENAME}.html index.adoc \
&& asciidoctor --trace --backend docbook --out-file - index.adoc | pandoc --from docbook --to docx --output /tmp/wis2-guide/guide/${FILE_BASENAME}.docx \
&& asciidoctor --trace -r asciidoctor-pdf --trace -b pdf -o /tmp/wis2-guide/guide/${FILE_BASENAME}.pdf index.adoc
4 changes: 2 additions & 2 deletions .github/workflows/test-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Test WIS2 Guide build
on:
pull_request:
paths:
- '**.adoc'
- '**.adoc'

env:
FILE_BASENAME: wis2-guide-APPROVED
Expand All @@ -19,7 +19,7 @@ jobs:
&& sudo apt-get install -y pandoc \
&& sudo gem install asciidoctor asciidoctor-pdf
- name: checkout repository
uses: actions/checkout@v3
uses: actions/checkout@master
- name: build documentation
run: |
mkdir -p /tmp/wis2-guide/guide/images \
Expand Down
8 changes: 8 additions & 0 deletions guide/sections/part1/data-consumer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ Links to where data can be accessed are made available through dataset discovery

A discovery metadata record or notification message may provide more than one download link. The preferred link will be identified as "canonical" (link relation: "rel": "canonical" footnote:[See Internet Assigned Numbers Authority (IANA) Link Relations: https://www.iana.org/assignments/link-relations/link-relations.xhtml]).

A data consumer should expect to receive multiple notification messages about the same data item. Nor should data consumers assume that messages arrive in time-sequence order (i.e., newest published message, as indicated by ``properties.pubtime``, arriving last). Consequently, for notification messages relating to the same data item (i.e., notification messages with identical ``properties.data_id``), they should:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjust one of the sentences?

"A data consumer should NOT expect to receive multiple notification messages about the same data item. Nor should data consumers assume..."
OR
"A data consumer should expect to receive multiple notification messages about the same data item. However, data consumers should NOT assume..."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took the second suggestion.


1. Prioritise the message with the latest publication time.
2. Discard any notification messages earlier publication time that have not yet been processed or may be received in the future.
3. Where a previous notification message with earlier publication time has already been processed, any data or metadata associated with the earlier notification message should be overwritten.

This means that a data consumer should keep track of notification messages that have been processed so that newly arrived notification messages can be compared with earlier messages identify which notification message relates to the latest version of the data or metadata. Given that messages propagate rapidly through WIS2, a record of previous messages need not exceed a 60-minute duration.

Where data are provided through an interactive web service, a canonical link containing a URL from which data consumers can directly download a data object may be complemented with an additional link providing the URL for the root of the web service from which data consumers can interact with or query the entire dataset.

If a download link implements access control (for example, the data consumer needs to take some additional action(s) to download the data object), it will contain a security object that provides the pertinent information (such as the access control mechanism used and where/how a data consumer would need to register to request access).
Expand Down