Adding colophon page for license, DOI and citation

.github/ISSUE_TEMPLATE/GitHub.md

@@ -0,0 +1,10 @@
+---
+name: GitHub
+about: For proposing changes to the the use of GitHub in this repository
+title: "*add your own title here*"
+labels: GitHub
+assignees: ''
+
+---
+
+Before submitting an issue be sure you have read and understand the GitHub contributing guidelines: https://github.com/cf-convention/cf-conventions/blob/main/CONTRIBUTING.md. Please describe the change you propose should be made, and link the PR, when available.

.github/workflows/adoc_build.yml

@@ -26,20 +26,16 @@ name: Asciidoctor Build Workflow
 on:
   # manually run workflow
   workflow_dispatch:
-
-  # trigger on PR event against default branch (i.e. main) (will not run publish job)
+  # trigger on PR event against main branch
   pull_request:
     branches: [ main ]
-  # Trigger on a push to default branch (i.e. main) (a PR is merged), or when a release is
-
-  # published on github. These will run the publish job.
+  # Trigger on a push on branch except gh-pages branch
   push:
-    branches: [ main ]
+    branches-ignore: [ gh-pages ]
   # Trigger when a GitHub release is published.
   release:
     types:
       - published
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: write
@@ -73,7 +69,11 @@ jobs:
     - name: Copy index.html
       run: |
         sudo cp -p .github/gh-pages/index.html build/
-
+    # Update H1 header
+    - name: Update H1 header
+      run: |
+        PATH_REVISION="${GITHUB_REPOSITORY}/${GITHUB_REF_TYPE}/${GITHUB_REF_NAME}@${GITHUB_SHA:0:7}"
+        sudo sed -i s/Latest/"${PATH_REVISION//\//\\/}"/ build/index.html;
     # Upload artifact containing cf-conventions.html, cf-conventions.pdf
     - name: Save cf-conventions and conformance docs
       uses: actions/upload-artifact@v4
@@ -126,10 +126,9 @@ jobs:
       - name: Determine where the new documents should live
         run: |
           if [[ ${{ github.event_name }} == 'release' ]]; then
-            # ${GITHUB_REF##*/} -> turns refs/tags/vM.m.p into vM.m.p
-            echo "TARGET_DIR=${GITHUB_REF##*/}" >> "$GITHUB_ENV"
+            echo "TARGET_DIR=releases/${GITHUB_REF_NAME}" >> "$GITHUB_ENV"
           else
-            echo "TARGET_DIR=." >> "$GITHUB_ENV"
+            echo "TARGET_DIR=${GITHUB_REF_TYPE}/${GITHUB_REF_NAME}" >> "$GITHUB_ENV"
           fi
       # Obtain the build artifacts from the previous jobs and place them in the
       # build/ directory
@@ -139,12 +138,10 @@ jobs:
           path: build/
       # If we are doing a release, we need to create the release directory
       - name: Make release directory
-        if: github.event_name == 'release'
         run: mkdir -p ${{ env.TARGET_DIR }}
       # If we are not doing a release, let's clean out the previous images
       # directory in the root directory (OLD TO BE DEPRECATED)
       - name: Remove old images directory
-        if: github.event_name != 'release'
         run: sudo rm -rf ${{ env.TARGET_DIR }}/images
       - name: Copy conventions and conformance documents
         run: |
@@ -157,12 +154,9 @@ jobs:
       # committed to the gh-pages branch
       - name: Remove artifact directory
         run: rm -rf build/
-      # If we are doing a release, update the index.html file to reflect the new
-      # latest release version.
-      - name: Update release index.html to point to new release
-        if: github.event_name == 'release'
-        run: |
-          sed -i s/Latest/"${GITHUB_REF##*/}"/ ${{ env.TARGET_DIR }}/index.html;
+      # Update root index.html: tree directories, excluding empty ones 
+      - name: Update root index.html
+        run: tree -T ${GITHUB_REPOSITORY} --dirsfirst --prune --noreport -I index.html -I README.md -H . -o index.html
       # Stage all changed files to git
       - name: Add all changes to git
         run: git add --all

CITATION.cff

@@ -0,0 +1,125 @@
+cff-version: 1.2.0
+license:
+- cc0-1.0
+title: NetCDF Climate and Forecast (CF) Metadata Conventions
+version: '1.11'
+date-released: '2023-12-05'
+doi: 10.5072/zenodo.130529
+abstract: This document describes the CF conventions for climate and forecast metadata
+  designed to promote the processing and sharing of files created with the netCDF
+  Application Programmer Interface. The conventions define metadata that provide a
+  definitive description of what the data in each variable represents, and of the
+  spatial and temporal properties of the data. This enables users of data from different
+  sources to decide which quantities are comparable, and facilitates building applications
+  with powerful extraction, regridding, and display capabilities. The CF conventions
+  generalize and extend the COARDS conventions. The extensions include metadata that
+  provides a precise definition of each variable via specification of a standard name,
+  describes the vertical locations corresponding to dimensionless vertical coordinate
+  values, and provides the spatial coordinates of non-rectilinear gridded data. Since
+  climate and forecast data are often not simply representative of points in space/time,
+  other extensions provide for the description of coordinate intervals, multidimensional
+  cells and climatological time coordinates, and indicate how a data value is representative
+  of an interval or cell. This standard also relaxes the COARDS constraints on dimension
+  order and specifies methods for reducing the size of datasets.
+authors:
+- affiliation: NCAR
+  family-names: Eaton
+  given-names: Brian
+- affiliation: University of Reading and UK Met Office Hadley Centre
+  family-names: Gregory
+  given-names: Jonathan
+  orcid: 0000-0003-1296-8644
+- affiliation: PCMDI, LLNL
+  family-names: Drach
+  given-names: Bob
+- affiliation: PCMDI, LLNL
+  family-names: Taylor
+  given-names: Karl
+  orcid: 0000-0002-6491-2135
+- affiliation: PMEL, NOAA
+  family-names: Hankin
+  given-names: Steve
+- affiliation: University of Reading
+  family-names: Blower
+  given-names: Jon
+- affiliation: Unidata
+  family-names: Caron
+  given-names: John
+- affiliation: USGS
+  family-names: Signell
+  given-names: Rich
+- affiliation: UK Met Office
+  family-names: Bentley
+  given-names: Phil
+- affiliation: MIT
+  family-names: Rappa
+  given-names: Greg
+- affiliation: DKRZ
+  family-names: "H\xF6ck"
+  given-names: Heinke
+  orcid: 0000-0002-0131-1404
+- affiliation: NCAS and CEDA
+  family-names: Pamment
+  given-names: Alison
+  orcid: 0000-0001-5040-4626
+- affiliation: NCAS
+  family-names: Juckes
+  given-names: Martin
+- affiliation: SMHI
+  family-names: Raspaud
+  given-names: Martin
+- affiliation: Excalibur Laboratories Inc
+  family-names: Horne
+  given-names: Randy
+- affiliation: University of Texas
+  family-names: Whiteaker
+  given-names: Timothy
+- affiliation: USGS
+  family-names: Blodgett
+  given-names: David
+- affiliation: UC Irvine
+  family-names: Zender
+  given-names: Charlie
+- affiliation: EUMETSAT
+  family-names: Lee
+  given-names: Daniel
+  orcid: 0000-0002-1041-232X
+- affiliation: NCAS and University of Reading
+  family-names: Hassell
+  given-names: David
+  orcid: 0000-0001-5106-7502
+- affiliation: Corteva Agriscience
+  family-names: Snow
+  given-names: Alan D.
+- affiliation: Max Planck Institute for Meteorology
+  family-names: "K\xF6lling"
+  given-names: Tobias
+- affiliation: NOAA/CIRES/University of Colorado
+  family-names: Allured
+  given-names: Dave
+- affiliation: HDF Group
+  family-names: Jelenak
+  given-names: Aleksandar
+- affiliation: EUMETSAT
+  family-names: Soerensen
+  given-names: Anders Meier
+- affiliation: OceanDataLab
+  family-names: Gaultier
+  given-names: Lucile
+- affiliation: OceanDataLab
+  family-names: "Herl\xE9dan"
+  given-names: Sylvain
+- affiliation: Puertos del Estado, Madrid
+  family-names: Manzano
+  given-names: Fernando
+- affiliation: SMHI Rossby Centre, Swedish Meteorological and Hydrological Institute
+  family-names: "B\xE4rring"
+  given-names: Lars
+  orcid: 0000-0001-7280-2502
+- affiliation: NOAA
+  family-names: Barker
+  given-names: Christopher
+- affiliation: National Centre for Atmospheric Science and University of Reading
+  family-names: Bartholomew
+  given-names: Sadie L.
+  orcid: 0000-0002-6180-3603

Makefile

@@ -35,7 +35,13 @@ DATE_FORMAT := +%d&\#160;%B,&\#160;%Y
 FINAL_TAG := -a final
 else
 DATE_FORMAT ?= +%d&\#160;%B,&\#160;%Y&\#160;%H:%M:%SZ
-FINAL_TAG ?= -a draft
+LOCAL_BRANCH=`git name-rev --name-only HEAD`
+TRACKING_BRANCH=`git config branch.$LOCAL_BRANCH.merge`
+TRACKING_REMOTE=`git config branch.$LOCAL_BRANCH.remote`
+REMOTE_URL=`git config remote.$TRACKING_REMOTE.url`
+#git config branch.$(git name-rev --name-only HEAD).remote
+#git name-rev --name-only HEAD
+FINAL_TAG ?= -a draft -a revnumber=v1.12.0-rc7-24-gb724218 -a revremark=${LOCAL_BRANCH}
 endif
 
 DATE_DOCPROD != LC_ALL=C date -u "$(DATE_FORMAT)"

cf-conventions.adoc

@@ -1,13 +1,36 @@
 include::version.adoc[]
 = NetCDF Climate and Forecast (CF) Metadata Conventions
-Brian{nbsp}Eaton; Jonathan{nbsp}Gregory; Bob{nbsp}Drach; Karl{nbsp}Taylor; Steve{nbsp}Hankin; Jon{nbsp}Blower; John{nbsp}Caron; Rich{nbsp}Signell; Phil{nbsp}Bentley; Greg{nbsp}Rappa; Heinke{nbsp}Höck; Alison{nbsp}Pamment; Martin{nbsp}Juckes; Martin{nbsp}Raspaud; Randy{nbsp}Horne; Timothy{nbsp}Whiteaker; David{nbsp}Blodgett; Charlie{nbsp}Zender; Daniel{nbsp}Lee; David{nbsp}Hassell; Alan{nbsp}D.{nbsp}Snow; Tobias{nbsp}Kölling; Dave{nbsp}Allured; Aleksandar{nbsp}Jelenak; Anders{nbsp}Meier{nbsp}Soerensen; Lucile{nbsp}Gaultier; Sylvain{nbsp}Herlédan; Fernando{nbsp}Manzano; Lars{nbsp}Bärring; Christopher{nbsp}Barker; Sadie{nbsp}Bartholomew
-Version{nbsp}{current-version},{nbsp}{nbsp}{docprodtime}: See{nbsp}https://cfconventions.org{nbsp}for{nbsp}further{nbsp}information.
+Brian Eaton; Jonathan Gregory; Bob Drach; Karl Taylor; Steve Hankin; Jon Blower; John Caron; Rich Signell; Phil Bentley; Greg Rappa; Heinke Höck; Alison Pamment; Martin Juckes; Martin Raspaud; Randy Horne; Timothy Whiteaker; David Blodgett; Charlie Zender; Daniel Lee; David Hassell; Alan D. Snow; Tobias Kölling; Dave Allured; Aleksandar Jelenak; Anders Meier Soerensen; Lucile Gaultier; Sylvain Herlédan; Fernando Manzano; Lars Bärring; Christopher Barker; Sadie Bartholomew
+:revnumber: {current-version}
+:revdate: {docprodtime}
 :doctype: book
 :pdf-folio-placement: physical
 :sectanchors:
 :toc: macro
 :toclevels: 3
 
+<<<
+Climate and Forecast Conventions version {current-version} {doi-text}
+
+image:images/cc-zero.svg[, 10%]
+This document is dedicated to the public domain following the link:https://creativecommons.org/publicdomain/zero/1.0/[Creative Commons Zero v1.0 Universal] Deed.
+
+The Climate and Forecasting Conventions website https://cfconventions.org/ contains additional resources and provides further information.
+ifdef::final[]
+ +
+ +
+ _Use the following reference to cite this version of the document:_ +
+Eaton, B., Gregory, J., Drach, B., Taylor, K., Hankin, S. et al. (2023). NetCDF Climate and Forecast (CF) Metadata Conventions ({current-version}). CF Community. https://doi.org/10.5072/zenodo.130529
+endif::[]
+ifndef::final[]
+ +
+ +
+ _DON’T use the following reference to cite this version of the document, as it is only shown as a draft:_ +
+Eaton, B., Gregory, J., Drach, B., Taylor, K., Hankin, S. et al. (2023). NetCDF Climate and Forecast (CF) Metadata Conventions ({current-version}). CF Community. https://doi.org/10.5072/zenodo.130529
+endif::[]
+
+'''
+
 toc::[]
 
 :numbered!:

default-theme-CF-version.yml

@@ -21,6 +21,8 @@ page:
   margin_inner: 0.75in
   margin_outer: 0.59in
   size: A4
+  numbering:
+    start-at: after-toc
 base:
   text_align: justify
   font_color: 333333
@@ -274,3 +276,7 @@ footer:
       content: '*{page-number}*'
     right:
       content: 'See https://cfconventions.org for further information'
+
+running-content:
+  start-at: toc
+