[Esip-documentation] Question on licensing of "Attribute Convention for Data Discovery 1.3" wiki page content

Mon Sep 24 12:43:21 EDT 2018

Thanks for doing the digging John

From: Esip-documentation <esip-documentation-bounces at lists.esipfed.org> on behalf of John Graybeal via Esip-documentation <esip-documentation at lists.esipfed.org>
Reply-To: John Graybeal <jbgraybeal at mindspring.com>
Date: Sunday, September 23, 2018 at 12:23 AM
To: Annie Burgess <annieburgess at esipfed.org>, "<esip-documentation at lists.esipfed.org>" <esip-documentation at lists.esipfed.org>
Subject: Re: [Esip-documentation] Question on licensing of "Attribute Convention for Data Discovery 1.3" wiki page content

sorry, never saw this list of questions earlier.  I can answer most of them, based on the last round, which had a process approved by the participating members of the committee.

A few quick references:
* the overview of ACDD is described at http://wiki.esipfed.org/index.php/Category:Attribute_Conventions_Dataset_Discovery; it includes answers to the questions below and many more, the history of previous versions, the Governance (!), and all the related documentation on the Wiki.
* the latest specification is pointed to by http://wiki.esipfed.org/index.php/Category:Attribute_Conventions_Dataset_Discovery

I can sum up the answers by saying, yes, actually, there was a well-defined and committee-approved process that produced released documents with the appropriately named URLs. It worked pretty well actually, given the technology is a a bit long in the tooth.

1) We created that structure of documents to meet the immediate management needs, but the Documentation Cluster did not create a protocol beyond the one we used to build the actual pages and manage the discussion. (So for example, I recall that we agreed that 70% of participating voters needed to approve a new standard in order for it to be released. Oh hey, just looked at the master document and there's a fair amount of Governance information there. That is the authoritative document (the overview document linked above).

2) The documents on the Wiki are the controlled documents. (Not perfect but very workable.)  They are version-controlled, so any changes can be detected, and they are not supposed to change once a particular release is approved.  When a new release is being considered, intermediate point-release documents are created to manage the discussion and the changes. When a new release is finally approved, the final document (with that release number in the title and URL) is created, and the 'non-versioned page' is reset to point to the latest version.  (This process was agreed by the group meeting for the last release of ACDD, and can be looked up by going back in the discussion list.)

3) changes of any type are managed by the documentation cluster (I see it says "ACDD Steering Committee", and there's even a list of people! conceivably we need to update that). I would recommend that the default operations be the ones previously adopted, until a new/better approach is agreed upon.

4a) As noted above, new intermediate documents are created during the discussion. The final document is created for the final vote.
4b) Yes, the document with the released version number (e.g, 1.3) in the wiki is the controlled document. See the Overview.
4c) Not sure what you mean by this question. Only wiki-authorized users may make changes to the documents, but there are a lot of those. (But if someone makes a change without permission, it will be obvious in the change history.) The pages are live.
4d) Yes, the wiki preserves change history for all changes.
4e) Yes, the URLs are unique for each release and contain the release version. So you can go to the ACDD 1.1 page and the ACDD 1.3 page and compare them manually. (Or automatically, after a few manual steps.)

John

On Sep 18, 2018, at 9:22 AM, Annie Burgess <annieburgess at esipfed.org<mailto:annieburgess at esipfed.org>> wrote:

Hi John, all -

The thread didn't end with a resolution. Based on your proposed solution (CEDAR), I wonder if others think that is a potential path forward OR if we should set up space (outside of email) for more discussion about Mark's previous questions related to hosting on the ESIP wiki:

1. Is there a management layer around
http://wiki.esipfed.org/index.php/Attribute_Convention_for_Data_Discovery
?
2. Is there a controlled document that manages any change to the list of names of the attributes and their definitions?
3. How would a change be managed?
  * an addition of a new attribute name?
  * a new attribute name?
4. From the perspective of managing the information, what happens once a change is agreed?
 * What content is changed?
 * Is there a controlled document that is considered the authoritative source?
 * Is a change made to a live web page by an authorized user?
 * Is there a record of these changes?
 * Is there a 'tag' that points to a particular release? (how may we compare ACDD-1.1 with ACDD-1.3)

Annie Burgess, PhD
ESIP Lab Director | Earth Science Information Partners (ESIP)
www http://esipfed.org<http://esipfed.org/> | phone 585.738.7549
Sign up for the monthly ESIP Lab update here<http://eepurl.com/dtKL8z>.
See the most recent update here<https://mailchi.mp/esipfed/esip-lab-a-virtual-earth-science-tech-space-2668717>.

On Sun, Sep 16, 2018 at 4:52 PM John Graybeal via Esip-documentation <esip-documentation at lists.esipfed.org<mailto:esip-documentation at lists.esipfed.org>> wrote:
Hi Erin, all,

Did this ever get addressed?  If you are just talking about defining fields in a computable form, I could put the whole thing into CEDAR (metadatacenter.org<http://metadatacenter.org/>) fairly quickly. Unfortunately the specification this produces is in JSON Schema, not triples.  But it would be on-line and public, and you could host the schema file on the ESIP site.

John

---------------------------------------
John Graybeal
jbgraybeal at mindspring.com<mailto:jbgraybeal at mindspring.com>
650-450-1853

On Jun 4, 2018, at 06:17, Erin Robinson via Esip-documentation <esip-documentation at lists.esipfed.org<mailto:esip-documentation at lists.esipfed.org>> wrote:

Hi Martin - We used to have semantic mediawiki working which would have spit out RDF triples for these things. It seems to be not working with our last upgrade. We will figure out a solution ASAP for a machine-readable file and get this to you.

E

Erin Robinson
Executive Director
ESIP - Earth Science Information Partners
esipfed.org<http://esipfed.org/> | 314.369.9954

On Sun, May 27, 2018 at 9:26 AM, Martin Desruisseaux <martin.desruisseaux at geomatys.com<mailto:martin.desruisseaux at geomatys.com>> wrote:
Le 27/05/2018 à 14:20, Ted Habermann a écrit :

Not sure what this looks like in XML, JSON, or CSV… Would MarkDown work? Seems more natural…
The intent is not to replace the wiki. It would be a copy of tables below "Global Attributes" section (only the tables, not the discussion before it) for consumption by machines rather than human. It could be something like that (other formats like CSV or XML would work as well, I'm neutral on that):

title = A short phrase or sentence describing the dataset. In many discovery systems (…)

summary = A paragraph describing the dataset, analogous to an abstract for a paper.

keywords = A comma-separated list of key words and/or phrases. Keywords may be (…)
It would allow external projects to insert automatically this documentation in their project at build time (in Apache SIS, I would use a custom javadoc tag for that purpose). If ESIP update their documentation, the updates would be reflected in external project documentation too.
The inconvenient is that if the wiki is updated, ESIP would need to remember to update above file accordingly, and conversely.
    Martin

_______________________________________________
Esip-documentation mailing list
Esip-documentation at lists.esipfed.org<mailto:Esip-documentation at lists.esipfed.org>
http://lists.deltaforce.net/mailman/listinfo/esip-documentation

_______________________________________________
Esip-documentation mailing list
Esip-documentation at lists.esipfed.org<mailto:Esip-documentation at lists.esipfed.org>
https://lists.esipfed.org/mailman/listinfo/esip-documentation

John Graybeal
jbgraybeal at mindspring.com<mailto:jbgraybeal at mindspring.com>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.esipfed.org/pipermail/esip-documentation/attachments/20180924/2c1e468b/attachment-0001.html>