Stages validation and new stage: Legacy

opoudjis commented 10 months ago

https://github.com/metanorma/metanorma-ogc/issues/444 concerns the fact that Legacy was added last year as a type of deprecation for OGC standards. In adding it to the relaton grammar, I've realised that we have not been validating stages in relaton-ogc until now.

This ticket is for the following:

Can we add document stages for the data in relaton-ogc?
If we can or already have, can we validate them against the following set? "rfc" | "candidate" | "published" | "deprecated" | "retired" | "legacy" | "rescinded" | "draft" | "work-item-draft" | "swg-draft" | "oab-review" | "public-ref" | "tc-vote" | "approved" | "deprecated" | "rescinded" | "retired" | "legacy"
If we can or already have, please make the needed changes to document scraping, to recognise the new "legacy" stage. I have asked @ghobona to provide us with examples of each of the deprecated stages, "deprecated" | "rescinded" | "retired" | "legacy"

andrew2net commented 10 months ago

@opoudjis we get the OGC dos from https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/definitions/docs/docs.json There are no stages or statuses in the source. We use hashmap to figure out if the document is a draft.

    TYPES = {
      "AS" => { type: "abstract-specification-topic" },
      "BP" => { type: "best-practice", subtype: "general" },
      "CAN" => { type: "standard", subtype: "general", stage: "draft" },
      # "CC" => "conformance-class",
      "CR" => { type: "change-request-supporting-document" },
      "CP" => { type: "community-practice" },
      "CS" => { type: "community-standard" },
      "DP" => { type: "discussion-paper" },
      "DP-Draft" => { type: "discussion-paper", stage: "draft" },
      "IPR" => { type: "engineering-report" },
      "IS" => { type: "standard", subtype: "implementation" },
      "ISC" => { type: "standard", subtype: "implementation" },
      "ISx" => { type: "standard", subtype: "extension" },
      "Notes" => { type: "other" },
      "ORM" => { type: "reference-model" },
      "PC" => { type: "standard", subtype: "profile" },
      "PER" => { type: "engineering-report" },
      "POL" => { type: "standard" },
      # "POLNTS" => "policy-name-type-specification",
      "Primer" => { type: "other" },
      "Profile" => { type: "standard", subtype: "profile" },
      "RFC" => { type: "standard", stage: "draft" },
      # "Retired" => "retired",
      "SAP" => { type: "standard", subtype: "profile" },
      # "TS" => "test-suite", # @PENDING
      "WhitePaper" => { type: "white-paper" },
      "ATB" => { type: "other" },
      "RP" => { type: "discussion-paper" },
    }.freeze

The abbreviation comes from the type field. Maybe we can get stages from the types?

opoudjis commented 10 months ago

I think this needs escalation to @ghobona, we clearly don't have Legacy in an easily looked-up form there. Leave it alone for now.

ghobona commented 10 months ago

Please search for "type":"D- in the document feed to bring up the deprecated documents.

andrew2net commented 10 months ago

The full list of types is: "CC", "PER", "DP", "CS", "IS", "AS", "ISC", "UG", "Notes", "D-ISC", "D-PER", "IS-Draft", "BP", "POL-NTS", "POL", "D-AS", "TechPaper", "CP", "D-DP", "D-IS", "TS", "Profile", "ISx", "D-BP", "Primer", "SAP", "ORM", "D-RFC", "D-SAP", "D-Profile", "CR", "Retired", "CAN", "PC", "DP-Draft", "D-RP", "D-ATB", "RFC", "D-ORM", "IPR".

The list of "D-*" like types is: "D-ISC", "D-PER", "D-AS", "D-DP", "D-IS", "D-BP", "D-RFC", "D-SAP", "D-Profile", "D-RP", "D-ATB", "D-ORM".

@opoudjis @ghobona We need to define Type => Stage mapping.

opoudjis commented 10 months ago

@ghobona I would assume D- means Deprecated and the rest are Published? But that's pretty constrained, compared to the states you allow for...

ghobona commented 10 months ago

@opoudjis I have just sent the question to the Infrastructure Office.

opoudjis commented 8 months ago

@andrew2net I've been informed that OGC 01-042 should be shown as status: Retired; is there anything in the source data that indicates this? It isn't showing up in the fetch.

That aside, I don't think there is much else to do. OGC have confirmed that no documents will be showing up yet in the source data with status: Legacy.

andrew2net commented 8 months ago

@opoudjis the OGC 01-042 has type type "Retired"

  "1294": {
    "title": "Topic Domain 1 - Telecommunications Domain",
    "alternative": "Topic Domain 1 - Telecommunications Domain",
    "URI": "",
    "identifier": "01-042",
    "URL": "https://portal.ogc.org/files/?artifact_id=1046",
    "type": "Retired",
    "creator": "Tom Strickland",
    "contributor": null,
    "description": "Domain Model for telecommunications Networks",
    "publisher": "Open Geospatial Consortium",
    "language": "English",
    "license": null,
    "source": null,
    "rights": "",
    "isPartOf": null,
    "date": "2001-10-09",
    "dateAccepted": null,
    "dateSubmitted": null,
    "format": null,
    "hasFormat": null,
    "extent": null
  },

relaton / relaton-ogc

Stages validation and new stage: Legacy #25